panel.widgets Package#

`widgets` Package#

Panel widgets makes your data exploration and apps interactive#

Panel provides a long range of basic and specialized widgets.

Check out the widget gallery https://panel.holoviz.org/reference/index.html#widgets for inspiration.

How to use Panel widgets in 4 simple steps#

Define your function

>>> def my_func(value1, value2):
...    ...
...    return some_python_object

Define your widgets

>>> widget1 = pn.widgets.SomeWidget(value=..., ...).servable(area='sidebar')
>>> widget2 = pn.widgets.AnotherWidget(value=..., ...).servable(area='sidebar')

Bind the function to your widgets

>>> interactive_func = pn.bind(my_func, value1=widget1, value2=widget2)

Layout your interactive function in a panel, Column, Row or similar

>>> pn.panel(interactive_func).servable()

For more detail see the Getting Started Guide https://panel.holoviz.org/getting_started/index.html

class panel.widgets.ArrayInput(*, max_array_size, description, placeholder, serializer, type, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: LiteralInput

The ArrayInput allows rendering and editing NumPy arrays in a text input widget.

Arrays larger than the max_array_size will be summarized and editing will be disabled.

Reference: https://panel.holoviz.org/reference/widgets/ArrayInput.html

Example:

>>> To be determined ...

Parameters inherited from:

max_array_size = param.Number(allow_refs=False, default=1000, inclusive_bounds=(True, True), label=’Max array size’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16a642fd0>): Arrays larger than this limit will be allowed in Python but will not be serialized into JavaScript. Although such large arrays will thus not be editable in the widget, such a restriction helps avoid overwhelming the browser and lets other widgets remain usable.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.AutocompleteInput(*, case_sensitive, description, min_characters, placeholder, restrict, search_strategy, value_input, options, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: SingleSelectBase

The AutocompleteInput widget allows selecting multiple values from a list of options.

It falls into the broad category of multi-value, option-selection widgets that provide a compatible API and include the MultiSelect, CrossSelector, CheckBoxGroup and CheckButtonGroup widgets.

The MultiChoice widget provides a much more compact UI than MultiSelect.

Reference: https://panel.holoviz.org/reference/widgets/AutocompleteInput.html

Example:

>>> AutocompleteInput(
...     name='Study', options=['Biology', 'Chemistry', 'Physics'],
...     placeholder='Write your study here ...'
... )

Parameters inherited from:

value = param.Parameter(allow_None=True, allow_refs=False, default=’’, label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16a32b690>): Initial or entered text value updated when <enter> key is pressed.
width = param.Integer(allow_None=True, allow_refs=False, bounds=(0, None), default=300, inclusive_bounds=(True, True), label=’Width’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16a3b4bd0>): Width of this component. If sizing_mode is set to stretch or scale mode this will merely be used as a suggestion.
case_sensitive = param.Boolean(allow_refs=False, default=True, label=’Case sensitive’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16a329ed0>): Enable or disable case sensitivity.
min_characters = param.Integer(allow_refs=False, default=2, inclusive_bounds=(True, True), label=’Min characters’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16a3b5910>): The number of characters a user must type before completions are presented.
placeholder = param.String(allow_refs=False, default=’’, label=’Placeholder’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16a32b9d0>): Placeholder for empty input field.
restrict = param.Boolean(allow_refs=False, default=True, label=’Restrict’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16a3b4690>): Set to False in order to allow users to enter text that is not present in the list of completion strings.
search_strategy = param.Selector(allow_refs=False, default=’starts_with’, label=’Search strategy’, names={}, nested_refs=False, objects=[‘starts_with’, ‘includes’], rx=<param.reactive.reactive_ops object at 0x16a32bc90>): Define how to search the list of completion strings. The default option “starts_with” means that the user’s text must match the start of a completion string. Using “includes” means that the user’s text can match any substring of a completion string.
value_input = param.String(allow_None=True, allow_refs=False, default=’’, label=’Value input’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16a3b4d50>): Initial or entered text value updated on every key press.
description = param.String(allow_None=True, allow_refs=False, label=’Description’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16a329f90>): An HTML string describing the function of this component.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.BooleanStatus(*, color, throttle, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: BooleanIndicator

The BooleanStatus is a boolean indicator providing a visual representation of a boolean status as filled or non-filled circle.

If the value is set to True the indicator will be filled while setting it to False will cause it to be non-filled.

Reference: https://panel.holoviz.org/reference/indicators/BooleanStatus.html

Example:

>>> BooleanStatus(value=True, color='primary', width=100, height=100)

Parameters inherited from:

value = param.Boolean(allow_refs=True, default=False, label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16a39eed0>): Whether the indicator is active or not.
height = param.Integer(allow_refs=True, bounds=(0, None), default=20, inclusive_bounds=(True, True), label=’Height’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16a2e7190>): height of the circle.
width = param.Integer(allow_refs=True, bounds=(0, None), default=20, inclusive_bounds=(True, True), label=’Width’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16a103450>): Width of the circle.
color = param.ObjectSelector(allow_refs=True, default=’dark’, label=’Color’, names={}, nested_refs=False, objects=[‘primary’, ‘secondary’, ‘success’, ‘info’, ‘danger’, ‘warning’, ‘light’, ‘dark’], rx=<param.reactive.reactive_ops object at 0x16a34b890>): The color of the circle, one of ‘primary’, ‘secondary’, ‘success’, ‘info’, ‘danger’, ‘warning’, ‘light’, ‘dark’

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.Button(*, clicks, button_style, button_type, icon, icon_size, description, description_delay, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: _ButtonBase, _ClickButton, IconMixin, TooltipMixin

The Button widget allows triggering events when the button is clicked.

The Button provides a value parameter, which will toggle from False to True while the click event is being processed

It also provides an additional clicks parameter, that can be watched to subscribe to click events.

Reference: https://panel.holoviz.org/reference/widgets/Button.html#widgets-gallery-button

Example:

>>> pn.widgets.Button(name='Click me', icon='caret-right', button_type='primary')

Parameters inherited from:

value = param.Event(allow_refs=True, default=False, label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16a3df8d0>): Toggles from False to True while the event is being processed.
clicks = param.Integer(allow_refs=True, default=0, inclusive_bounds=(True, True), label=’Clicks’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16a624f10>): Number of clicks (can be listened to)

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

js_on_click(args: dict[str, Any] = {}, code: str = '') → Callback[source]#

Allows defining a JS callback to be triggered when the button is clicked.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
code: str: The Javascript code to execute when the button is clicked.

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a Javascript (JS) callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
**callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] | None = None, args: dict[str, Any] | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Button to those on the target object in Javascript (JS) code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value(s) to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally. Default is False.
**links: dict[str,str]: A mapping between properties on the source model and the target model property to link it to.

Returns#

Link: The Link can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

on_click(callback: Callable[[Event], None | Awaitable[None]]) → Watcher[source]#

Register a callback to be executed when the Button is clicked.

The callback is given an Event argument declaring the number of clicks

Example#

>>> button = pn.widgets.Button(name='Click me')
>>> def handle_click(event):
...    print("I was clicked!")
>>> button.on_click(handle_click)

Arguments#

callback:: The function to run on click events. Must accept a positional Event argument. Can be a sync or async function

Returns#

watcher: param.Parameterized.Watcher: A Watcher that executes the callback when the button is clicked.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.ButtonIcon(*, clicks, toggle_duration, active_icon, icon, size, description, description_delay, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: _ClickableIcon, _ClickButton, TooltipMixin

The ButtonIcon widget facilitates event triggering upon button clicks.

This widget displays a default icon initially. Upon being clicked, an active_icon appears for a specified toggle_duration.

For instance, the ButtonIcon can be effectively utilized to implement a feature akin to ChatGPT’s copy-to-clipboard button.

The button incorporates a value attribute, which alternates between False and True as the click event is processed.

Furthermore, it includes an clicks attribute, enabling subscription to click events for further actions or monitoring.

Reference: https://panel.holoviz.org/reference/widgets/ButtonIcon.html

Example:

>>> button_icon = pn.widgets.ButtonIcon(
...     icon='clipboard',
...     active_icon='check',
...     description='Copy',
...     toggle_duration=2000
... )

Parameters inherited from:

value = param.Boolean(allow_refs=False, default=False, label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x169f49e10>): Toggles from False to True while the event is being processed.
clicks = param.Integer(allow_refs=False, default=0, inclusive_bounds=(True, True), label=’Clicks’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16a792e50>): The number of times the button has been clicked.
toggle_duration = param.Integer(allow_refs=False, default=75, inclusive_bounds=(True, True), label=’Toggle duration’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16a793450>): The number of milliseconds the active_icon should be shown for and how long the button should be disabled for.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

js_on_click(args: dict[str, Any] = {}, code: str = '') → Callback[source]#

Allows defining a JS callback to be triggered when the button is clicked.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
code: str: The Javascript code to execute when the button is clicked.

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a Javascript (JS) callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
**callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

on_click(callback: Callable[[Event], None]) → Watcher[source]#

Register a callback to be executed when the button is clicked.

The callback is given an Event argument declaring the number of clicks.

Arguments#

callback: (Callable[[param.parameterized.Event], None]): The function to run on click events. Must accept a positional Event argument

Returns#

watcher: param.Parameterized.Watcher: A Watcher that executes the callback when the MenuButton is clicked.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.CheckBoxGroup(*, inline, options, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: _CheckGroupBase

The CheckBoxGroup widget allows selecting between a list of options by ticking the corresponding checkboxes.

It falls into the broad category of multi-option selection widgets that provide a compatible API and include the MultiSelect, CrossSelector and CheckButtonGroup widgets.

Reference: https://panel.holoviz.org/reference/widgets/CheckBoxGroup.html

Example:

>>> CheckBoxGroup(
...     name='Fruits', value=['Apple', 'Pear'], options=['Apple', 'Banana', 'Pear', 'Strawberry'],
...     inline=True
... )

Parameters inherited from:

inline = param.Boolean(allow_refs=False, default=False, label=’Inline’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x169a84450>): Whether the items be arrange vertically (False) or horizontally in-line (True).

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.CheckButtonGroup(*, orientation, options, button_style, button_type, description, description_delay, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: _CheckGroupBase, _ButtonBase, TooltipMixin

The CheckButtonGroup widget allows selecting between a list of options by toggling the corresponding buttons.

It falls into the broad category of multi-option selection widgets that provide a compatible API and include the MultiSelect, CrossSelector and CheckBoxGroup widgets.

Reference: https://panel.holoviz.org/reference/widgets/CheckButtonGroup.html

Example:

>>> CheckButtonGroup(
...     name='Regression Models', value=['Lasso', 'Ridge'],
...     options=['Lasso', 'Linear', 'Ridge', 'Polynomial']
... )

Parameters inherited from:

orientation = param.Selector(allow_refs=False, default=’horizontal’, label=’Orientation’, names={}, nested_refs=False, objects=[‘horizontal’, ‘vertical’], rx=<param.reactive.reactive_ops object at 0x169de9f10>): Button group orientation, either ‘horizontal’ (default) or ‘vertical’.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.Checkbox(**params: Any)[source]#

Bases: _BooleanWidget

The Checkbox allows toggling a single condition between True/False states by ticking a checkbox.

This widget is interchangeable with the Toggle widget.

Reference: https://panel.holoviz.org/reference/widgets/Checkbox.html

Example:

>>> Checkbox(name='Works with the tools you know and love', value=True)

Parameters inherited from:

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.CodeEditor(*, annotations, filename, language, on_keyup, print_margin, readonly, theme, value_input, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: Widget

The CodeEditor widget allows displaying and editing code in the powerful Ace editor.

Reference: https://panel.holoviz.org/reference/widgets/CodeEditor.html

Example:

>>> CodeEditor(value=py_code, language='python', theme='monokai')

Parameters inherited from:

value = param.String(allow_refs=False, default=’’, label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1698acf50>): State of the current code in the editor if on_keyup. Otherwise, only upon loss of focus, i.e. clicking outside the editor, or pressing <Ctrl+Enter> or <Cmd+Enter>.
annotations = param.List(allow_refs=False, bounds=(0, None), default=[], label=’Annotations’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16989cbd0>): List of annotations to add to the editor.
filename = param.String(allow_refs=False, default=’’, label=’Filename’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1698ade50>): Filename from which to deduce language
language = param.String(allow_refs=False, default=’text’, label=’Language’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16989ee90>): Language of the editor
on_keyup = param.Boolean(allow_refs=False, default=True, label=’On keyup’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1698acc10>): Whether to update the value on every key press or only upon loss of focus / hotkeys.
print_margin = param.Boolean(allow_refs=False, default=False, label=’Print margin’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16989d7d0>): Whether to show the a print margin.
readonly = param.Boolean(allow_refs=False, default=False, label=’Readonly’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1698acc10>): Define if editor content can be modified. Alias for disabled.
theme = param.ObjectSelector(allow_refs=False, default=’chrome’, label=’Theme’, names={}, nested_refs=False, objects=[‘ambiance’, ‘chaos’, ‘chrome’, ‘clouds’, ‘clouds_midnight’, ‘cobalt’, ‘crimson_editor’, ‘dawn’, ‘dracula’, ‘dreamweaver’, ‘eclipse’, ‘github’, ‘gob’, ‘gruvbox’, ‘idle_fingers’, ‘iplastic’, ‘katzenmilch’, ‘kr_theme’, ‘kuroir’, ‘merbivore’, ‘merbivore_soft’, ‘mono_industrial’, ‘monokai’, ‘pastel_on_dark’, ‘solarized_dark’, ‘solarized_light’, ‘sqlserver’, ‘terminal’, ‘textmate’, ‘tomorrow’, ‘tomorrow_night’, ‘tomorrow_night_blue’, ‘tomorrow_night_bright’, ‘tomorrow_night_eighties’, ‘twilight’, ‘vibrant_ink’, ‘xcode’], rx=<param.reactive.reactive_ops object at 0x16989e150>): Theme of the editor
value_input = param.String(allow_refs=False, default=’’, label=’Value input’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1698ade50>): State of the current code updated on every key press. Identical to value if on_keyup.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.ColorPicker(**params: Any)[source]#

Bases: Widget

The ColorPicker widget allows selecting a hexadecimal RGB color value using the browser’s color-picking widget.

Reference: https://panel.holoviz.org/reference/widgets/ColorPicker.html

Example:

>>> ColorPicker(name='Color', value='#99ef78')

Parameters inherited from:

value = param.Color(allow_None=True, allow_named=True, allow_refs=False, label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x169a44790>): The selected color
width = param.Integer(allow_None=True, allow_refs=False, bounds=(0, None), default=52, inclusive_bounds=(True, True), label=’Width’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x169912090>): Width of this component. If sizing_mode is set to stretch or scale mode this will merely be used as a suggestion.
description = param.String(allow_None=True, allow_refs=False, label=’Description’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x169912810>): An HTML string describing the function of this component.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.CompositeWidget(*, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: Widget

A baseclass for widgets which are made up of two or more other widgets

Parameters inherited from:

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.CrossSelector(*, definition_order, filter_fn, size, description, options, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: CompositeWidget, MultiSelect

A composite widget which allows selecting from a list of items by moving them between two lists. Supports filtering values by name to select them in bulk.

Reference: https://panel.holoviz.org/reference/widgets/CrossSelector.html

Example:

>>> CrossSelector(
...     name='Fruits', value=['Apple', 'Pear'],
...     options=['Apple', 'Banana', 'Pear', 'Strawberry']
... )

Parameters inherited from:

height = param.Integer(allow_None=True, allow_refs=False, bounds=(0, None), default=200, inclusive_bounds=(True, True), label=’Height’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x169585690>): The number of options shown at once (note this is the only way to control the height of this widget)
width = param.Integer(allow_None=True, allow_refs=False, bounds=(0, None), default=600, inclusive_bounds=(True, True), label=’Width’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16935df90>): The number of options shown at once (note this is the only way to control the height of this widget)
size = param.Integer(allow_refs=False, default=10, inclusive_bounds=(True, True), label=’Size’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x169585710>): The number of options shown at once (note this is the only way to control the height of this widget)
filter_fn = param.Callable(allow_refs=False, label=’Filter fn’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16a43ac90>): The filter function applied when querying using the text fields, defaults to re.search. Function is two arguments, the query or pattern and the item label.
definition_order = param.Integer(allow_refs=False, default=True, inclusive_bounds=(True, True), label=’Definition order’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x169585990>): Whether to preserve definition order after filtering. Disable to allow the order of selection to define the order of the selected list.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

filter_fn(string, flags=0)[source]#: Scan through string looking for a match to the pattern, returning a Match object, or None if no match was found.

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

on_double_click(callback: Callable[[Event], None | Awaitable[None]]) → Watcher[source]#

Register a callback to be executed when a MultiSelect option is double-clicked.

The callback is given an DoubleClickEvent argument

Example#

>>> select = pn.widgets.MultiSelect(options=["A", "B", "C"])
>>> def handle_click(event):
...    print(f"Option {event.option} was double clicked.")
>>> select.on_double_click(handle_click)

Arguments#

callback:: The function to run on click events. Must accept a positional Event argument. Can be a sync or async function

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.DataFrame(value=None, **params)[source]#

Bases: BaseTable

The DataFrame widget allows displaying and editing a pandas DataFrame.

Note that editing is not possible for multi-indexed DataFrames, in which case you will need to reduce the DataFrame to a single index.

Also note that the DataFrame widget will eventually be replaced with the Tabulator widget, and so new code should be written to use Tabulator instead.

Reference: https://panel.holoviz.org/reference/widgets/DataFrame.html

Example:

>>> DataFrame(df, name='DataFrame')

Parameters inherited from:

auto_edit = param.Boolean(allow_refs=False, default=False, label=’Auto edit’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1693bba90>): Whether clicking on a table cell automatically starts edit mode.
autosize_mode = param.ObjectSelector(allow_refs=False, default=’force_fit’, label=’Autosize mode’, names={}, nested_refs=False, objects=[‘none’, ‘fit_columns’, ‘fit_viewport’, ‘force_fit’], rx=<param.reactive.reactive_ops object at 0x1693ba710>): Determines the column autosizing mode, as one of the following options: "fit_columns" Compute column widths based on cell contents while ensuring the table fits into the available viewport. This results in no horizontal scrollbar showing up, but data can get unreadable if there is not enough space available. "fit_viewport" Adjust the viewport size after computing column widths based on cell contents. "force_fit" Fit columns into available space dividing the table width across the columns equally (equivalent to fit_columns=True). This results in no horizontal scrollbar showing up, but data can get unreadable if there is not enough space available. "none" Do not automatically compute column widths.
fit_columns = param.Boolean(allow_None=True, allow_refs=False, label=’Fit columns’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1693b8790>): Whether columns should expand to the available width. This results in no horizontal scrollbar showing up, but data can get unreadable if there is no enough space available.
frozen_columns = param.Integer(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’Frozen columns’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1693ba4d0>): Integer indicating the number of columns to freeze. If set, the first N columns will be frozen, which prevents them from scrolling out of frame.
frozen_rows = param.Integer(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’Frozen rows’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1693b9e50>): Integer indicating the number of rows to freeze. If set, the first N rows will be frozen, which prevents them from scrolling out of frame; if set to a negative value the last N rows will be frozen.
reorderable = param.Boolean(allow_refs=False, default=True, label=’Reorderable’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16911e210>): Allows the reordering of a table’s columns. To reorder a column, click and drag a table’s header to the desired location in the table. The columns on either side will remain in their previous order.
sortable = param.Boolean(allow_refs=False, default=True, label=’Sortable’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16945fa50>): Allows to sort table’s contents. By default natural order is preserved. To sort a column, click on its header. Clicking one more time changes sort direction. Use Ctrl + click to return to natural order. Use Shift + click to sort multiple columns simultaneously.

add_filter(filter, column=None)[source]#

Adds a filter to the table which can be a static value or dynamic parameter based object which will automatically update the table when changed..

When a static value, widget or parameter is supplied the filtering will follow a few well defined behaviors:

Arguments#

filter: Widget, param.Parameter or FunctionType: The value by which to filter the DataFrame along the declared column, or a function accepting the DataFrame to be filtered and returning a filtered copy of the DataFrame.
column: str or None: Column to which the filter will be applied, if the filter is a constant value, widget or parameter.

Raises#

ValueError: If the filter type is not supported or no column: was declared.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

property current_view#: Returns the current view of the table after filtering and sorting are applied.

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

patch(patch_value, as_index=True)[source]#

Efficiently patches (updates) the existing value with the patch_value.

Arguments#

patch_value: (pd.DataFrame | pd.Series | Dict): The value(s) to patch the existing value with.
as_index: boolean: Whether to treat the patch index as DataFrame indexes (True) or as simple integer index.

Raises#

ValueError: Raised if the patch_value is not a supported type.

Examples#

Patch a DataFrame with a Dictionary row. >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> tabulator = Tabulator(value=value) >>> patch_value = {“x”: [(0, 3)]} >>> tabulator.patch(patch_value) >>> tabulator.value.to_dict(“list”) {‘x’: [3, 2], ‘y’: [‘a’, ‘b’]}

Patch a Dataframe with a Dictionary of Columns. >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> tabulator = Tabulator(value=value) >>> patch_value = {“x”: [(slice(2), (3,4))], “y”: [(1,’d’)]} >>> tabulator.patch(patch_value) >>> tabulator.value.to_dict(“list”) {‘x’: [3, 4], ‘y’: [‘a’, ‘d’]}

Patch a DataFrame with a Series. Please note the index is used in the update. >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> tabulator = Tabulator(value=value) >>> patch_value = pd.Series({“index”: 1, “x”: 4, “y”: “d”}) >>> tabulator.patch(patch_value) >>> tabulator.value.to_dict(“list”) {‘x’: [1, 4], ‘y’: [‘a’, ‘d’]}

Patch a Dataframe with a Dataframe. Please note the index is used in the update. >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> tabulator = Tabulator(value=value) >>> patch_value = pd.DataFrame({“x”: [3, 4], “y”: [“c”, “d”]}) >>> tabulator.patch(patch_value) >>> tabulator.value.to_dict(“list”) {‘x’: [3, 4], ‘y’: [‘c’, ‘d’]}

remove_filter(filter)[source]#: Removes a filter which was previously added.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

property selected_dataframe#: Returns a DataFrame of the currently selected rows.

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

stream(stream_value, rollover=None, reset_index=True)[source]#

Streams (appends) the stream_value provided to the existing value in an efficient manner.

Arguments#

stream_value: (pd.DataFrame | pd.Series | Dict): The new value(s) to append to the existing value.
rollover: int: A maximum column size, above which data from the start of the column begins to be discarded. If None, then columns will continue to grow unbounded.
reset_index: (bool, default=True): If True and the stream_value is a DataFrame, then its index is reset. Helps to keep the index unique and named index

Raises#

ValueError: Raised if the stream_value is not a supported type.

Examples#

Stream a Series to a DataFrame >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> tabulator = Tabulator(value=value) >>> stream_value = pd.Series({“x”: 4, “y”: “d”}) >>> tabulator.stream(stream_value) >>> tabulator.value.to_dict(“list”) {‘x’: [1, 2, 4], ‘y’: [‘a’, ‘b’, ‘d’]}

Stream a Dataframe to a Dataframe >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> tabulator = Tabulator(value=value) >>> stream_value = pd.DataFrame({“x”: [3, 4], “y”: [“c”, “d”]}) >>> tabulator.stream(stream_value) >>> tabulator.value.to_dict(“list”) {‘x’: [1, 2, 3, 4], ‘y’: [‘a’, ‘b’, ‘c’, ‘d’]}

Stream a Dictionary row to a DataFrame >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> tabulator = Tabulator(value=value) >>> stream_value = {“x”: 4, “y”: “d”} >>> tabulator.stream(stream_value) >>> tabulator.value.to_dict(“list”) {‘x’: [1, 2, 4], ‘y’: [‘a’, ‘b’, ‘d’]}

Stream a Dictionary of Columns to a Dataframe >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> tabulator = Tabulator(value=value) >>> stream_value = {“x”: [3, 4], “y”: [“c”, “d”]} >>> tabulator.stream(stream_value) >>> tabulator.value.to_dict(“list”) {‘x’: [1, 2, 3, 4], ‘y’: [‘a’, ‘b’, ‘c’, ‘d’]}

class panel.widgets.DatePicker(*, description, disabled_dates, enabled_dates, end, start, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: Widget

The DatePicker allows selecting a date value using a text box and a date-picking utility.

Reference: https://panel.holoviz.org/reference/widgets/DatePicker.html

Example:

>>> DatePicker(
...     value=date(2025,1,1),
...     start=date(2025,1,1), end=date(2025,12,31),
...     name='Date'
... )

Parameters inherited from:

value = param.CalendarDate(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1691e5dd0>): The current value
width = param.Integer(allow_None=True, allow_refs=False, bounds=(0, None), default=300, inclusive_bounds=(True, True), label=’Width’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16911af50>): Width of this component. If sizing_mode is set to stretch or scale mode this will merely be used as a suggestion.
start = param.CalendarDate(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’Start’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1691e40d0>): Inclusive lower bound of the allowed date selection
end = param.CalendarDate(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’End’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16911add0>): Inclusive upper bound of the allowed date selection

disabled_dates = param.List(allow_None=True, allow_refs=False, bounds=(0, None), class_=(<class ‘datetime.date’>, <class ‘str’>), item_type=(<class ‘datetime.date’>, <class ‘str’>), label=’Disabled dates’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16a3acc50>)

enabled_dates = param.List(allow_None=True, allow_refs=False, bounds=(0, None), class_=(<class ‘datetime.date’>, <class ‘str’>), item_type=(<class ‘datetime.date’>, <class ‘str’>), label=’Enabled dates’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1691e66d0>)

description = param.String(allow_None=True, allow_refs=False, label=’Description’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1691d4950>): An HTML string describing the function of this component.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.DateRangePicker(*, description, disabled_dates, enabled_dates, end, start, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: Widget

The DateRangePicker allows selecting a date range using a text box and a date-picking utility.

Reference: https://panel.holoviz.org/reference/widgets/DateRangePicker.html

Example:

>>> DateRangePicker(
...     value=(date(2025,1,1), date(2025,1,5)),
...     start=date(2025,1,1), end=date(2025,12,31),
...     name='Date range'
... )

Parameters inherited from:

value = param.DateRange(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’Value’, length=2, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x169080a10>): The current value
width = param.Integer(allow_None=True, allow_refs=False, bounds=(0, None), default=300, inclusive_bounds=(True, True), label=’Width’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x169068d50>): Width of this component. If sizing_mode is set to stretch or scale mode this will merely be used as a suggestion.
start = param.CalendarDate(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’Start’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1690809d0>): Inclusive lower bound of the allowed date selection
end = param.CalendarDate(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’End’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x169068c10>): Inclusive upper bound of the allowed date selection

disabled_dates = param.List(allow_None=True, allow_refs=False, bounds=(0, None), class_=(<class ‘datetime.date’>, <class ‘str’>), item_type=(<class ‘datetime.date’>, <class ‘str’>), label=’Disabled dates’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1690815d0>)

enabled_dates = param.List(allow_None=True, allow_refs=False, bounds=(0, None), class_=(<class ‘datetime.date’>, <class ‘str’>), item_type=(<class ‘datetime.date’>, <class ‘str’>), label=’Enabled dates’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x169068d50>)

description = param.String(allow_None=True, allow_refs=False, label=’Description’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x169081610>): An HTML string describing the function of this component.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.DateRangeSlider(*, end, format, start, step, value_throttled, bar_color, direction, orientation, show_value, tooltips, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: _SliderBase

The DateRangeSlider widget allows selecting a date range using a slider with two handles. Supports datetime.datetime, datetime.date and np.datetime64 ranges.

Reference: https://panel.holoviz.org/reference/widgets/DateRangeSlider.html

Example:

>>> import datetime as dt
>>> DateRangeSlider(
...     value=(dt.datetime(2025, 1, 9), dt.datetime(2025, 1, 16)),
...     start=dt.datetime(2025, 1, 1),
...     end=dt.datetime(2025, 1, 31),
...     step=2,
...     name="A tuple of datetimes"
... )

Parameters inherited from:

value = param.DateRange(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’Value’, length=2, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1691bb250>): The selected range as a tuple of values. Updated when one of the handles is dragged. Supports datetime.datetime, datetime.date, and np.datetime64 ranges.
value_start = param.Date(allow_None=True, allow_refs=False, constant=True, inclusive_bounds=(True, True), label=’Value start’, nested_refs=False, readonly=True, rx=<param.reactive.reactive_ops object at 0x168ec0dd0>): The lower value of the selected range.
value_end = param.Date(allow_None=True, allow_refs=False, constant=True, inclusive_bounds=(True, True), label=’Value end’, nested_refs=False, readonly=True, rx=<param.reactive.reactive_ops object at 0x1691b9450>): The upper value of the selected range.
value_throttled = param.DateRange(allow_None=True, allow_refs=False, constant=True, inclusive_bounds=(True, True), label=’Value throttled’, length=2, nested_refs=True, rx=<param.reactive.reactive_ops object at 0x168ead3d0>): The selected range as a tuple of values. Updated one of the handles is released. Supports datetime.datetime, datetime.date and np.datetime64 ranges
start = param.Date(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’Start’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1691b9450>): The lower bound.
end = param.Date(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’End’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x168ec1450>): The upper bound.
step = param.Number(allow_refs=False, default=1, inclusive_bounds=(True, True), label=’Step’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x169218ed0>): The step size in days. Default is 1 day.
format = param.String(allow_None=True, allow_refs=False, label=’Format’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16908bcd0>): Datetime format used for parsing and formatting the date.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.DateSlider(*, as_datetime, end, format, start, step, value_throttled, bar_color, direction, orientation, show_value, tooltips, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: _SliderBase

The DateSlider widget allows selecting a value within a set of bounds using a slider. Supports datetime.datetime, datetime.date and np.datetime64 values. The step size is fixed at 1 day.

Reference: https://panel.holoviz.org/reference/widgets/DateSlider.html

Example:

>>> import datetime as dt
>>> DateSlider(
...     value=dt.datetime(2025, 1, 1),
...     start=dt.datetime(2025, 1, 1),
...     end=dt.datetime(2025, 1, 7),
...     name="A datetime value"
... )

Parameters inherited from:

value = param.Date(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x168dd5890>): The selected date value of the slider. Updated when the slider handle is dragged. Supports datetime.datetime, datetime.date or np.datetime64 types.
value_throttled = param.Date(allow_None=True, allow_refs=False, constant=True, inclusive_bounds=(True, True), label=’Value throttled’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x168d27110>): The value of the slider. Updated when the slider handle is released.
start = param.Date(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’Start’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x168dd74d0>): The lower bound.
end = param.Date(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’End’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x168d26f90>): The upper bound.
as_datetime = param.Boolean(allow_refs=False, default=False, label=’As datetime’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x168d06ad0>): Whether to store the date as a datetime.
step = param.Integer(allow_refs=False, bounds=(1, None), default=1, inclusive_bounds=(True, True), label=’Step’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x168d26f90>): The step parameter in days.
format = param.String(allow_None=True, allow_refs=False, label=’Format’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x168dbb990>): Datetime format used for parsing and formatting the date.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.DatetimeInput(*, end, format, start, description, placeholder, serializer, type, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: LiteralInput

The DatetimeInput allows specifying Python datetime like values using a text input widget.

An optional type may be declared.

Reference: https://panel.holoviz.org/reference/widgets/DatetimeInput.html

Example:

>>> DatetimeInput(name='Datetime', value=datetime(2019, 2, 8))

Parameters inherited from:

value = param.Date(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x168ab2e90>): The current value
start = param.Date(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’Start’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x168b30110>): Inclusive lower bound of the allowed date selection
end = param.Date(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’End’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x168ab2550>): Inclusive upper bound of the allowed date selection
format = param.String(allow_refs=False, default=’%Y-%m-%d %H:%M:%S’, label=’Format’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x168b31990>): Datetime format used for parsing and formatting the datetime.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

type[source]#: alias of datetime

class panel.widgets.DatetimePicker(*, mode, as_numpy_datetime64, description, disabled_dates, enable_seconds, enable_time, enabled_dates, end, military_time, start, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: _DatetimePickerBase

The DatetimePicker allows selecting selecting a datetime value using a textbox and a datetime-picking utility.

Reference: https://panel.holoviz.org/reference/widgets/DatetimePicker.html

Example:

>>> DatetimePicker(
...    value=datetime(2025,1,1,22,0),
...    start=date(2025,1,1), end=date(2025,12,31),
...    military_time=True, name='Date and time'
... )

Parameters inherited from:

value = param.Date(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x168949850>): The widget value which the widget type resolves to when used as a reactive param reference.

mode = param.String(allow_refs=False, constant=True, default=’single’, label=’Mode’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x168d226d0>)

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.DatetimeRangeInput(*, end, format, start, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: CompositeWidget

The DatetimeRangeInput widget allows selecting a datetime range using two DatetimeInput widgets, which return a tuple range.

Reference: https://panel.holoviz.org/reference/widgets/DatetimeRangeInput.html

Example:

>>> DatetimeRangeInput(
...     name='Datetime Range',
...     value=(datetime(2017, 1, 1), datetime(2018, 1, 10)),
...     start=datetime(2017, 1, 1), end=datetime(2019, 1, 1),
... )

Parameters inherited from:

value = param.Tuple(allow_refs=False, default=(None, None), label=’Value’, length=2, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x168375990>): The current value
start = param.Date(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’Start’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x168734350>): Inclusive lower bound of the allowed date selection
end = param.Date(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’End’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x168737090>): Inclusive upper bound of the allowed date selection
format = param.String(allow_refs=False, default=’%Y-%m-%d %H:%M:%S’, label=’Format’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x168797550>): Datetime format used for parsing and formatting the datetime.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.DatetimeRangePicker(*, mode, as_numpy_datetime64, description, disabled_dates, enable_seconds, enable_time, enabled_dates, end, military_time, start, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: _DatetimePickerBase

The DatetimeRangePicker allows selecting selecting a datetime range using a text box and a datetime-range-picking utility.

Reference: https://panel.holoviz.org/reference/widgets/DatetimeRangePicker.html

Example:

>>> DatetimeRangePicker(
...    value=(datetime(2025,1,1,22,0), datetime(2025,1,2,22,0)),
...    start=date(2025,1,1), end=date(2025,12,31),
...    military_time=True, name='Datetime Range'
... )

Parameters inherited from:

value = param.DateRange(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’Value’, length=2, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1682ef610>): The current value

mode = param.String(allow_refs=False, constant=True, default=’range’, label=’Mode’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1682edfd0>)

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.DatetimeRangeSlider(*, end, format, start, step, value_throttled, bar_color, direction, orientation, show_value, tooltips, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: DateRangeSlider

The DatetimeRangeSlider widget allows selecting a datetime range using a slider with two handles. Supports datetime.datetime and np.datetime64 ranges.

Reference: https://panel.holoviz.org/reference/widgets/DatetimeRangeSlider.html

Example:

>>> import datetime as dt
>>> DatetimeRangeSlider(
...     value=(dt.datetime(2025, 1, 9), dt.datetime(2025, 1, 16)),
...     start=dt.datetime(2025, 1, 1),
...     end=dt.datetime(2025, 1, 31),
...     step=10000,
...     name="A tuple of datetimes"
... )

Parameters inherited from:

step = param.Number(allow_refs=False, default=60000, inclusive_bounds=(True, True), label=’Step’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1681d3dd0>): The step size in ms. Default is 1 min.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.Debugger(*, _number_of_errors, _number_of_infos, _number_of_warnings, formatter_args, level, logger_names, only_last, active_header_background, button_css_classes, collapsed, collapsible, header, header_background, header_color, header_css_classes, hide_header, title, title_css_classes, auto_scroll_limit, scroll_button_threshold, scroll_position, view_latest, scroll, objects, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, name)[source]#

Bases: Card

A uneditable Card layout holding a terminal printing out logs from your callbacks. By default, it will only print exceptions. If you want to add your own log, use the panel.callbacks logger within your callbacks: logger = logging.getLogger(‘panel.callbacks’)

Parameters inherited from:

_number_of_errors = param.Integer(allow_refs=False, bounds=(0, None), default=0, inclusive_bounds=(True, True), label=’ number of errors’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x168ece950>): Number of logged errors since last acknowledged.
_number_of_warnings = param.Integer(allow_refs=False, bounds=(0, None), default=0, inclusive_bounds=(True, True), label=’ number of warnings’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x168f4f710>): Number of logged warnings since last acknowledged.
_number_of_infos = param.Integer(allow_refs=False, bounds=(0, None), default=0, inclusive_bounds=(True, True), label=’ number of infos’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x168ece950>): Number of logged information since last acknowledged.
only_last = param.Boolean(allow_refs=False, default=True, label=’Only last’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x168e0eed0>): Whether only the last stack is printed or the full.
level = param.Integer(allow_refs=False, default=40, inclusive_bounds=(True, True), label=’Level’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x168ecce10>): Logging level to print in the debugger terminal.
formatter_args = param.Dict(allow_refs=False, class_=<class ‘dict’>, default={‘fmt’: ‘%(asctime)s [%(name)s - %(levelname)s]: %(message)s’}, label=’Formatter args’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x168f4eed0>): Arguments to pass to the logging formatter. See the standard python logging libraries.
logger_names = param.List(allow_refs=False, bounds=(1, None), class_=<class ‘str’>, default=[‘panel’], item_type=<class ‘str’>, label=’Logger names’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16836bc90>): Loggers which will be prompted in the debugger terminal.

append(obj: Any) → None[source]#: Appends an object to the layout.

Arguments#

obj (object): Panel component to add to the layout.

clear() → list[Viewable][source]#: Clears the objects on this layout.

Returns#

objects (list[Viewable]): List of cleared objects.

clone(*objects: Any, **params: Any) → ListLike[source]#: Makes a copy of the layout sharing the same parameters.

Arguments#

objects: Objects to add to the cloned layout. params: Keyword arguments override the parameters on the clone.

Returns#

Cloned layout object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

extend(objects: Iterable[Any]) → None[source]#: Extends the objects on this layout with a list.

Arguments#

objects (list): List of panel components to add to the layout.

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

index(object) → int[source]#: Returns the integer index of the supplied object in the list of objects.

Arguments#

obj (object): Panel component to look up the index for.

Returns#

index (int): Integer index of the object in the layout.

insert(index: int, obj: Any) → None[source]#: Inserts an object in the layout at the specified index.

Arguments#

index (int): Index at which to insert the object. object (object): Panel components to insert in the layout.

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

pop(index: int) → Viewable[source]#: Pops an item from the layout by index.

Arguments#

index (int): The index of the item to pop from the layout.

remove(obj: Viewable) → None[source]#: Removes an object from the layout.

Arguments#

obj (object): The object to remove from the layout.

reverse() → None[source]#: Reverses the objects in the layout.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.Dial(*, annulus_width, background, bounds, colors, default_color, end_angle, format, label_color, nan_format, needle_color, needle_width, start_angle, tick_size, title_size, unfilled_color, value_size, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: ValueIndicator

A Dial represents a value in some range as a position on an annular dial. It is similar to a Gauge but more minimal visually.

Reference: https://panel.holoviz.org/reference/indicators/Dial.html

Example:

>>> Dial(name='Speed', value=79, format="{value} km/h", bounds=(0, 200), colors=[(0.4, 'green'), (1, 'red')])

Parameters inherited from:

value = param.Number(allow_None=True, allow_refs=False, default=25, inclusive_bounds=(True, True), label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x167fa8bd0>): Value to indicate on the dial a value within the declared bounds.
height = param.Integer(allow_refs=False, bounds=(1, None), default=250, inclusive_bounds=(True, True), label=’Height’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x167c6a3d0>): The height of the component (in pixels). This can be either fixed or preferred height, depending on height sizing policy.
width = param.Integer(allow_refs=False, bounds=(1, None), default=250, inclusive_bounds=(True, True), label=’Width’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x167ead110>): The width of the component (in pixels). This can be either fixed or preferred width, depending on width sizing policy.
annulus_width = param.Number(allow_refs=False, default=0.2, inclusive_bounds=(True, True), label=’Annulus width’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x167c68050>): Width of the radial annulus as a fraction of the total.
background = param.Parameter(allow_None=True, allow_refs=False, label=’Background’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x167eadb10>): Background color of the component.
bounds = param.Range(allow_refs=False, default=(0, 100), inclusive_bounds=(True, True), label=’Bounds’, length=2, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x169a344d0>): The upper and lower bound of the dial.
colors = param.List(allow_None=True, allow_refs=False, bounds=(0, None), label=’Colors’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x167eadf90>): Color thresholds for the Dial, specified as a list of tuples of the fractional threshold and the color to switch to.
default_color = param.String(allow_refs=False, default=’lightblue’, label=’Default color’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x167e64150>): Color of the radial annulus if not color thresholds are supplied.
end_angle = param.Number(allow_refs=False, default=25, inclusive_bounds=(True, True), label=’End angle’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x167eadf90>): Angle at which the dial ends.
format = param.String(allow_refs=False, default=’{value}%’, label=’Format’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x167e64390>): Formatting string for the value indicator and lower/upper bounds.
label_color = param.String(allow_refs=False, default=’black’, label=’Label color’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x167eac7d0>): Color for all extraneous labels.
nan_format = param.String(allow_refs=False, default=’-’, label=’Nan format’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x167e64390>): How to format nan values.
needle_color = param.String(allow_refs=False, default=’black’, label=’Needle color’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x167eadbd0>): Color of the Dial needle.
needle_width = param.Number(allow_refs=False, default=0.1, inclusive_bounds=(True, True), label=’Needle width’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x167ead8d0>): Radial width of the needle.
start_angle = param.Number(allow_refs=False, default=-205, inclusive_bounds=(True, True), label=’Start angle’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x167eac850>): Angle at which the dial starts.
tick_size = param.String(allow_None=True, allow_refs=False, label=’Tick size’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x167e64390>): Font size of the Dial min/max labels.
title_size = param.String(allow_None=True, allow_refs=False, label=’Title size’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x167eaca50>): Font size of the Dial title.
unfilled_color = param.String(allow_refs=False, default=’whitesmoke’, label=’Unfilled color’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x167e64390>): Color of the unfilled region of the Dial.
value_size = param.String(allow_None=True, allow_refs=False, label=’Value size’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x167eada10>): Font size of the Dial value label.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.DiscretePlayer(*, value_throttled, direction, interval, loop_policy, preview_duration, scale_buttons, show_loop_controls, show_value, step, value_align, visible_buttons, visible_loop_options, options, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: PlayerBase, SelectBase

The DiscretePlayer provides controls to iterate through a list of discrete options. The speed at which the widget plays is defined by the interval (in milliseconds), but it is also possible to skip items using the step parameter.

Reference: https://panel.holoviz.org/reference/widgets/DiscretePlayer.html

Example:

>>> DiscretePlayer(
...     name='Discrete Player',
...     options=[2, 4, 8, 16, 32, 64, 128], value=32,
...     loop_policy='loop',
...     value_align='start'
... )

Parameters inherited from:

value = param.Parameter(allow_None=True, allow_refs=False, label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x167d0bbd0>): Current player value
interval = param.Integer(allow_refs=False, default=500, inclusive_bounds=(True, True), label=’Interval’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x167d27490>): Interval between updates
show_value = param.Boolean(allow_refs=False, default=True, label=’Show value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x167d0b610>): Whether to show the widget value
value_throttled = param.Parameter(allow_None=True, allow_refs=False, constant=True, label=’Value throttled’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x167d27e90>): Current player value

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.DiscreteSlider(*, formatter, options, value_throttled, bar_color, direction, orientation, show_value, tooltips, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: CompositeWidget, _SliderBase

The DiscreteSlider widget allows selecting a value from a discrete list or dictionary of values using a slider.

Reference: https://panel.holoviz.org/reference/widgets/DiscreteSlider.html

Example:

>>> DiscreteSlider(
...     value=0,
...     options=list([0, 1, 2, 4, 8, 16, 32, 64]),
...     name="A discrete value",
... )

Parameters inherited from:

value = param.Parameter(allow_None=True, allow_refs=False, label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x167aa3250>): The selected value of the slider. Updated when the handle is dragged. Must be one of the options.
value_throttled = param.Parameter(allow_None=True, allow_refs=False, constant=True, label=’Value throttled’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x167ba2950>): The value of the slider. Updated when the handle is released.
options = param.ClassSelector(allow_refs=False, class_=(<class ‘dict’>, <class ‘list’>), default=[], label=’Options’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x167aa3250>): A list or dictionary of valid options.
formatter = param.String(allow_refs=False, default=’%.3g’, label=’Formatter’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x167ba2950>): A custom format string. Separate from format parameter since formatting is applied in Python, not via the bokeh TickFormatter.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

property labels#: The list of labels to display

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

property values#: The list of option values

class panel.widgets.EditableFloatSlider(*, fixed_end, fixed_start, editable, end, start, step, value_throttled, format, bar_color, direction, orientation, show_value, tooltips, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: _EditableContinuousSlider, FloatSlider

The EditableFloatSlider widget allows selecting selecting a numeric floating-point value within a set of bounds using a slider and for more precise control offers an editable number input box.

Reference: https://panel.holoviz.org/reference/widgets/EditableFloatSlider.html

Example:

>>> EditableFloatSlider(
...     value=1.0, start=0.0, end=2.0, step=0.25, name="A float value"
... )

Parameters inherited from:

fixed_start = param.Number(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’Fixed start’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x167a33690>): A fixed lower bound for the slider and input.
fixed_end = param.Number(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’Fixed end’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1679e2a10>): A fixed upper bound for the slider and input.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.EditableIntSlider(*, fixed_end, fixed_start, editable, end, start, step, value_throttled, format, bar_color, direction, orientation, show_value, tooltips, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: _EditableContinuousSlider, IntSlider

The EditableIntSlider widget allows selecting selecting an integer value within a set of bounds using a slider and for more precise control offers an editable integer input box.

Reference: https://panel.holoviz.org/reference/widgets/EditableIntSlider.html

Example:

>>> EditableIntSlider(
...     value=2, start=0, end=5, step=1, name="An integer value"
... )

Parameters inherited from:

fixed_start = param.Integer(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’Fixed start’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x167884250>): A fixed lower bound for the slider and input.
fixed_end = param.Integer(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’Fixed end’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1678afc50>): A fixed upper bound for the slider and input.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.EditableRangeSlider(*, editable, end, fixed_end, fixed_start, format, start, step, value_throttled, bar_color, direction, orientation, show_value, tooltips, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: CompositeWidget, _SliderBase

The EditableRangeSlider widget allows selecting a floating-point range using a slider with two handles and for more precise control also offers a set of number input boxes.

Reference: https://panel.holoviz.org/reference/widgets/EditableRangeSlider.html

Example:

>>> EditableRangeSlider(
...      value=(1.0, 1.5), start=0.0, end=2.0, step=0.25, name="A tuple of floats"
... )

Parameters inherited from:

value = param.Range(allow_refs=False, default=(0, 1), inclusive_bounds=(True, True), label=’Value’, length=2, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16786c4d0>): Current range value. Updated when a handle is dragged.
show_value = param.Boolean(allow_refs=False, constant=True, default=False, label=’Show value’, nested_refs=False, readonly=True, rx=<param.reactive.reactive_ops object at 0x167607890>): Whether to show the widget value.
value_throttled = param.Range(allow_None=True, allow_refs=False, constant=True, inclusive_bounds=(True, True), label=’Value throttled’, length=2, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x167654a50>): The value of the slider. Updated when the handle is released.
start = param.Number(allow_refs=False, default=0.0, inclusive_bounds=(True, True), label=’Start’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x167606450>): Lower bound of the range.
end = param.Number(allow_refs=False, default=1.0, inclusive_bounds=(True, True), label=’End’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x167654f90>): Upper bound of the range.
fixed_start = param.Number(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’Fixed start’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x167606190>): A fixed lower bound for the slider and input.
fixed_end = param.Number(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’Fixed end’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x167654f90>): A fixed upper bound for the slider and input.
step = param.Number(allow_refs=False, default=0.1, inclusive_bounds=(True, True), label=’Step’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1676041d0>): Slider and number input step.
editable = param.Tuple(allow_refs=False, default=(True, True), label=’Editable’, length=2, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1676557d0>): Whether the lower and upper values are editable.
format = param.ClassSelector(allow_refs=False, class_=(<class ‘str’>, <class ‘bokeh.models.formatters.TickFormatter’>), default=’0.0[0000]’, label=’Format’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x167654110>): Allows defining a custom format string or bokeh TickFormatter.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.FileDownload(file=None, **params)[source]#

Bases: IconMixin

The FileDownload widget allows a user to download a file.

It works either by sending the file data to the browser on initialization (`embed`=True), or when the button is clicked.

Reference: https://panel.holoviz.org/reference/widgets/FileDownload.html

Example:

>>> FileDownload(file='IntroductionToPanel.ipynb', filename='intro.ipynb')

Parameters inherited from:

auto = param.Boolean(allow_refs=False, default=True, label=’Auto’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16754e810>): Whether to download on the initial click or allow for right-click save as.
button_type = param.ObjectSelector(allow_refs=False, default=’default’, label=’Button type’, names={}, nested_refs=False, objects=[‘default’, ‘primary’, ‘success’, ‘warning’, ‘danger’, ‘light’], rx=<param.reactive.reactive_ops object at 0x16753da50>): A button theme; should be one of ‘default’ (white), ‘primary’ (blue), ‘success’ (green), ‘info’ (yellow), ‘light’ (light), or ‘danger’ (red).
button_style = param.ObjectSelector(allow_refs=False, default=’solid’, label=’Button style’, names={}, nested_refs=False, objects=[‘solid’, ‘outline’], rx=<param.reactive.reactive_ops object at 0x16753dd50>): A button style to switch between ‘solid’, ‘outline’.
callback = param.Callable(allow_None=True, allow_refs=False, label=’Callback’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16753d510>): A callable that returns the file path or file-like object.
data = param.String(allow_None=True, allow_refs=False, label=’Data’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16753d710>): The data being transferred.
embed = param.Boolean(allow_refs=False, default=False, label=’Embed’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16753d690>): Whether to embed the file on initialization.
file = param.Parameter(allow_None=True, allow_refs=False, label=’File’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16754ebd0>): The file, Path, file-like object or file contents to transfer. If the file is not pointing to a file on disk a filename must also be provided.
filename = param.String(allow_None=True, allow_refs=False, label=’Filename’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16753d690>): A filename which will also be the default name when downloading the file.
label = param.String(allow_refs=False, default=’Download file’, label=’Label’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16754e150>): The label of the download button
description = param.String(allow_None=True, allow_refs=False, label=’Description’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16753dd50>): An HTML string describing the function of this component.

_clicks = param.Integer(allow_refs=False, default=0, inclusive_bounds=(True, True), label=’ clicks’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16753ddd0>)

_transfers = param.Integer(allow_refs=False, default=0, inclusive_bounds=(True, True), label=’ transfers’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16753d810>)

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.FileDropper(*, accepted_filetypes, chunk_size, layout, max_file_size, max_files, max_total_file_size, mime_type, multiple, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: Widget

The FileDropper allows the user to upload one or more files to the server.

It is similar to the FileInput widget but additionally adds support for chunked uploads, making it possible to upload large files. The UI also supports previews for image files. Unlike FileInput the uploaded files are stored as dictionary of bytes object indexed by the filename.

Reference: https://panel.holoviz.org/reference/widgets/FileDropper.html

Example:

>>> FileDropper(accepted_filetypes=['image/*'], multiple=True)

Parameters inherited from:

value = param.Dict(allow_refs=False, class_=<class ‘dict’>, default={}, label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x167378710>): A dictionary containing the uploaded file(s) as bytes or string objects indexed by the filename. Files that have a text/* mimetype will automatically be decoded as utf-8.
width = param.Integer(allow_None=True, allow_refs=False, bounds=(0, None), default=300, inclusive_bounds=(True, True), label=’Width’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x167446cd0>): Width of this component. If sizing_mode is set to stretch or scale mode this will merely be used as a suggestion.
accepted_filetypes = param.List(allow_refs=False, bounds=(0, None), default=[], label=’Accepted filetypes’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1675aff50>): List of accepted file types. Can be mime types, file extensions or wild cards.For instance [‘image/*’] will accept all images. [‘.png’, ‘image/jpeg’] will only accepts PNGs and JPEGs.
chunk_size = param.Integer(allow_refs=False, default=10000000, inclusive_bounds=(True, True), label=’Chunk size’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1674458d0>): Size in bytes per chunk transferred across the WebSocket.
layout = param.Selector(allow_refs=False, label=’Layout’, names={}, nested_refs=False, objects=[‘circle’, ‘compact’, ‘integrated’], rx=<param.reactive.reactive_ops object at 0x1675aff50>): Compact mode will remove padding, integrated mode is used to render FilePond as part of a bigger element. Circle mode adjusts the item position offsets so buttons and progress indicators don’t fall outside of the circular shape.
max_file_size = param.String(allow_None=True, allow_refs=False, label=’Max file size’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x167447ed0>): Maximum size of a file as a string with units given in KB or MB, e.g. 5MB or 750KB.
max_files = param.Integer(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’Max files’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x167447d90>): Maximum number of files that can be uploaded if multiple=True.
max_total_file_size = param.String(allow_None=True, allow_refs=False, label=’Max total file size’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x167447fd0>): Maximum size of all uploaded files, as a string with units given in KB or MB, e.g. 5MB or 750KB.
mime_type = param.Dict(allow_refs=False, class_=<class ‘dict’>, default={}, label=’Mime type’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1675aff50>): A dictionary containing the mimetypes for each of the uploaded files indexed by their filename.
multiple = param.Boolean(allow_refs=False, default=False, label=’Multiple’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x167447a10>): Whether to allow uploading multiple files.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.FileInput(**params: Any)[source]#

Bases: Widget

The FileInput allows the user to upload one or more files to the server.

It makes the filename, MIME type and (bytes) content available in Python.

Please note

you can in fact drag and drop files onto the FileInput.
you easily save the files using the save method.

Reference: https://panel.holoviz.org/reference/widgets/FileInput.html

Example:

>>> FileInput(accept='.png,.jpeg', multiple=True)

Parameters inherited from:

value = param.Parameter(allow_None=True, allow_refs=False, label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x167193c90>): The uploaded file(s) stored as a single bytes object if multiple is False or a list of bytes otherwise.
accept = param.String(allow_None=True, allow_refs=False, label=’Accept’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16719a990>): A comma separated string of all extension types that should be supported.
description = param.String(allow_None=True, allow_refs=False, label=’Description’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x167193c90>): An HTML string describing the function of this component rendered as a tooltip icon.
directory = param.Boolean(allow_refs=False, default=False, label=’Directory’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x167198bd0>): Whether to allow selection of directories instead of files. The filename will be relative paths to the uploaded directory. .. note:: When a directory is uploaded it will give add a confirmation pop up. The confirmation pop up cannot be disabled, as this is a security feature in the browser. .. note:: The accept parameter only works with file extension. When using accept with directory, the number of files reported will be the total amount of files, not the filtered.
filename = param.ClassSelector(allow_None=True, allow_refs=False, class_=(<class ‘str’>, <class ‘list’>), label=’Filename’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x167199350>): Name of the uploaded file(s).
mime_type = param.ClassSelector(allow_None=True, allow_refs=False, class_=(<class ‘str’>, <class ‘list’>), label=’Mime type’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1671c6ad0>): Mimetype of the uploaded file(s).
multiple = param.Boolean(allow_refs=False, default=False, label=’Multiple’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x167191a50>): Whether to allow uploading multiple files. If enabled value parameter will return a list.

clear()[source]#: Clear the file(s) in the FileInput widget

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename)[source]#: Saves the uploaded FileInput data object(s) to file(s) or BytesIO object(s).

Arguments#

filename (str or list[str]): File path or file-like object

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.FileSelector(directory: AnyStr | PathLike | None = None, **params)[source]#

Bases: CompositeWidget

The FileSelector widget allows browsing the filesystem on the server and selecting one or more files in a directory.

Reference: https://panel.holoviz.org/reference/widgets/FileSelector.html

Example:

>>> FileSelector(directory='~', file_pattern='*.png')

Parameters inherited from:

value = param.List(allow_refs=False, bounds=(0, None), default=[], label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16758d3d0>): List of selected files.
directory = param.String(allow_refs=False, default=’/Users/runner/work/panel/panel/doc’, label=’Directory’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x166eb2fd0>): The directory to explore.
file_pattern = param.String(allow_refs=False, default=’*’, label=’File pattern’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16758d3d0>): A glob-like pattern to filter the files.
only_files = param.Boolean(allow_refs=False, default=False, label=’Only files’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x166eb1410>): Whether to only allow selecting files.
show_hidden = param.Boolean(allow_refs=False, default=False, label=’Show hidden’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16758c250>): Whether to show hidden files and directories (starting with a period).
size = param.Integer(allow_refs=False, default=10, inclusive_bounds=(True, True), label=’Size’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x166eb3c90>): The number of options shown at once (note this is the only way to control the height of this widget)
refresh_period = param.Integer(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’Refresh period’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x166ecd590>): If set to non-None value indicates how frequently to refresh the directory contents in milliseconds.
root_directory = param.String(allow_None=True, allow_refs=False, label=’Root directory’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x166eb2bd0>): If set, overrides directory parameter as the root directory beyond which users cannot navigate.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.FloatInput(*, step, value_throttled, page_step_multiplier, wheel_wait, mode, description, end, format, placeholder, start, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: _SpinnerBase, _FloatInputBase

The FloatInput allows selecting a floating point value using a spinbox.

It behaves like a slider except that the lower and upper bounds are optional and a specific value can be entered. The value can be changed using the keyboard (up, down, page up, page down), mouse wheel and arrow buttons.

Reference: https://panel.holoviz.org/reference/widgets/FloatInput.html

Example:

>>> FloatInput(name='Value', value=5., step=1e-1, start=0, end=10)

Parameters inherited from:

placeholder = param.String(allow_refs=False, default=’’, label=’Placeholder’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x167064790>): Placeholder when the value is empty.
step = param.Number(allow_refs=False, default=0.1, inclusive_bounds=(True, True), label=’Step’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16704c950>): The step size.
value_throttled = param.Number(allow_None=True, allow_refs=False, constant=True, inclusive_bounds=(True, True), label=’Value throttled’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16704ca50>): The current value. Updates only on <enter> or when the widget looses focus.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.FloatSlider(*, end, start, step, value_throttled, format, bar_color, direction, orientation, show_value, tooltips, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: ContinuousSlider

The FloatSlider widget allows selecting a floating-point value within a set of bounds using a slider.

Reference: https://panel.holoviz.org/reference/widgets/FloatSlider.html

Example:

>>> FloatSlider(value=0.5, start=0.0, end=1.0, step=0.1, name="Float value")

Parameters inherited from:

value = param.Number(allow_None=True, allow_refs=False, default=0.0, inclusive_bounds=(True, True), label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x166c64050>): The selected floating-point value of the slider. Updated when the handle is dragged.
start = param.Number(allow_refs=False, default=0.0, inclusive_bounds=(True, True), label=’Start’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x166c17690>): The lower bound.
end = param.Number(allow_refs=False, default=1.0, inclusive_bounds=(True, True), label=’End’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x166c64050>): The upper bound.
step = param.Number(allow_refs=False, default=0.1, inclusive_bounds=(True, True), label=’Step’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x166c17a90>): The step size.
value_throttled = param.Number(allow_None=True, allow_refs=False, constant=True, inclusive_bounds=(True, True), label=’Value throttled’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x166c5f950>): The value of the slider. Updated when the handle is released.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.Gauge(*, annulus_width, bounds, colors, custom_opts, end_angle, format, num_splits, show_labels, show_ticks, start_angle, title_size, tooltip_format, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: ValueIndicator

A Gauge represents a value in some range as a position on speedometer or gauge. It is similar to a Dial but visually a lot busier.

Reference: https://panel.holoviz.org/reference/indicators/Gauge.html

Example:

>>> Gauge(name='Speed', value=79, bounds=(0, 200), colors=[(0.4, 'green'), (1, 'red')])

Parameters inherited from:

value = param.Number(allow_refs=False, default=25, inclusive_bounds=(True, True), label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x166991510>): Value to indicate on the gauge a value within the declared bounds.
height = param.Integer(allow_refs=False, bounds=(0, None), default=300, inclusive_bounds=(True, True), label=’Height’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x166bb3e90>): The height of the component (in pixels). This can be either fixed or preferred height, depending on height sizing policy.
width = param.Integer(allow_refs=False, bounds=(0, None), default=300, inclusive_bounds=(True, True), label=’Width’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x166991c50>): The width of the component (in pixels). This can be either fixed or preferred width, depending on width sizing policy.
annulus_width = param.Integer(allow_refs=False, default=10, inclusive_bounds=(True, True), label=’Annulus width’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x166f2e290>): Width of the gauge annulus.
bounds = param.Range(allow_refs=False, default=(0, 100), inclusive_bounds=(True, True), label=’Bounds’, length=2, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x15e0e6b50>): The upper and lower bound of the dial.
colors = param.List(allow_None=True, allow_refs=False, bounds=(0, None), label=’Colors’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16a793c90>): Color thresholds for the Gauge, specified as a list of tuples of the fractional threshold and the color to switch to.
custom_opts = param.Dict(allow_None=True, allow_refs=False, class_=<class ‘dict’>, label=’Custom opts’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x166a895d0>): Additional options to pass to the ECharts Gauge definition.
end_angle = param.Number(allow_refs=False, default=-45, inclusive_bounds=(True, True), label=’End angle’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16697a390>): Angle at which the gauge ends.
format = param.String(allow_refs=False, default=’{value}%’, label=’Format’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x166a89510>): Formatting string for the value indicator.
num_splits = param.Integer(allow_refs=False, default=10, inclusive_bounds=(True, True), label=’Num splits’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x166a893d0>): Number of splits along the gauge.
show_ticks = param.Boolean(allow_refs=False, default=True, label=’Show ticks’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x166a89690>): Whether to show ticks along the dials.
show_labels = param.Boolean(allow_refs=False, default=True, label=’Show labels’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x158b6a090>): Whether to show tick labels along the dials.
start_angle = param.Number(allow_refs=False, default=225, inclusive_bounds=(True, True), label=’Start angle’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x166a890d0>): Angle at which the gauge starts.
tooltip_format = param.String(allow_refs=False, default=’{b}{c}%’, label=’Tooltip format’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x166f2d850>): Formatting string for the hover tooltip.
title_size = param.Integer(allow_refs=False, default=18, inclusive_bounds=(True, True), label=’Title size’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x166a890d0>): Size of title font.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.Grammar(*, src, uri, weight, name)[source]#

Bases: Parameterized

A set of words or patterns of words that we want the speech recognition service to recognize

For example

grammar = Grammar(: src=’#JSGF V1.0; grammar colors; public <color> = aqua | azure | beige;’, weight=0.7

)

Wraps the HTML SpeechGrammar API. See https://developer.mozilla.org/en-US/docs/Web/API/SpeechGrammar

src = param.String(allow_refs=False, default=’’, label=’Src’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16645c390>): A set of words or patterns of words that we want the recognition service to recognize. Defined using JSpeech Grammar Format. See https://www.w3.org/TR/jsgf/.
uri = param.String(allow_refs=False, default=’’, label=’Uri’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1666abdd0>): An uri pointing to the definition. If src is available it will be used. Otherwise uri. The uri will be loaded on the client side only.
weight = param.Number(allow_refs=False, bounds=(0.0, 1.0), default=1, inclusive_bounds=(True, True), label=’Weight’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x15e4cc5d0>, step=0.01): The weight of the grammar. A number in the range 0–1. Default is 1.

serialize()[source]#: Returns the grammar as dict

class panel.widgets.GrammarList(iterable=(), /)[source]#

Bases: list

A list of Grammar objects containing words or patterns of words that we want the recognition service to recognize.

Example:

grammar = ‘#JSGF V1.0; grammar colors; public <color> = aqua | azure | beige | bisque ;’ grammar_list = GrammarList() grammar_list.add_from_string(grammar, 1)

Wraps the HTML 5 SpeechGrammarList API

See https://developer.mozilla.org/en-US/docs/Web/API/SpeechGrammarList

add_from_string(src, weight=1.0)[source]#: Takes a src and weight and adds it to the GrammarList as a new Grammar object. The new Grammar object is returned.

add_from_uri(uri, weight=1.0)[source]#: Takes a grammar present at a specific uri, and adds it to the GrammarList as a new Grammar object. The new Grammar object is returned.

append(object, /)#: Append object to the end of the list.

clear()#: Remove all items from list.

copy()#: Return a shallow copy of the list.

count(value, /)#: Return number of occurrences of value.

extend(iterable, /)#: Extend list by appending elements from the iterable.

index(value, start=0, stop=9223372036854775807, /)#

Return first index of value.

Raises ValueError if the value is not present.

insert(index, object, /)#: Insert object before index.

pop(index=-1, /)#

Remove and return item at index (default last).

Raises IndexError if list is empty or index is out of range.

remove(value, /)#

Remove first occurrence of value.

Raises ValueError if the value is not present.

reverse()#: Reverse IN PLACE.

serialize()[source]#: Returns a list of serialized grammars

sort(*, key=None, reverse=False)#

Sort the list in ascending order and return None.

The sort is in-place (i.e. the list itself is modified) and stable (i.e. the order of two equal elements is maintained).

If a key function is given, apply it once to each list item and sort them, ascending or descending, according to their function values.

The reverse flag can be set to sort in descending order.

class panel.widgets.IntInput(*, step, value_throttled, page_step_multiplier, wheel_wait, mode, description, end, format, placeholder, start, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: _SpinnerBase, _IntInputBase

The IntInput allows selecting an integer value using a spinbox.

It behaves like a slider except that lower and upper bounds are optional and a specific value can be entered. The value can be changed using the keyboard (up, down, page up, page down), mouse wheel and arrow buttons.

Reference: https://panel.holoviz.org/reference/widgets/IntInput.html

Example:

>>> IntInput(name='Value', value=100, start=0, end=1000, step=10)

Parameters inherited from:

step = param.Integer(allow_refs=False, default=1, inclusive_bounds=(True, True), label=’Step’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x166768a50>): The step size.
value_throttled = param.Integer(allow_None=True, allow_refs=False, constant=True, inclusive_bounds=(True, True), label=’Value throttled’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x166744050>): The current value. Updates only on <enter> or when the widget looses focus.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.IntRangeSlider(*, end, format, start, step, value_throttled, bar_color, direction, orientation, show_value, tooltips, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: RangeSlider

The IntRangeSlider widget allows selecting an integer range using a slider with two handles.

Reference: https://panel.holoviz.org/reference/widgets/IntRangeSlider.html

Example:

>>> IntRangeSlider(
...     value=(2, 4), start=0, end=10, step=2, name="A tuple of integers"
... )

Parameters inherited from:

start = param.Integer(allow_refs=False, default=0, inclusive_bounds=(True, True), label=’Start’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16644bbd0>): The lower bound.
end = param.Integer(allow_refs=False, default=1, inclusive_bounds=(True, True), label=’End’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16645aad0>): The upper bound.
step = param.Integer(allow_refs=False, default=1, inclusive_bounds=(True, True), label=’Step’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16644b350>): The step size

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.IntSlider(*, end, start, step, value_throttled, format, bar_color, direction, orientation, show_value, tooltips, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: ContinuousSlider

The IntSlider widget allows selecting an integer value within a set of bounds using a slider.

Reference: https://panel.holoviz.org/reference/widgets/IntSlider.html

Example:

>>> IntSlider(value=5, start=0, end=10, step=1, name="Integer Value")

Parameters inherited from:

value = param.Integer(allow_None=True, allow_refs=False, default=0, inclusive_bounds=(True, True), label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x162084790>): The selected integer value of the slider. Updated when the handle is dragged.
start = param.Integer(allow_refs=False, default=0, inclusive_bounds=(True, True), label=’Start’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1666f2c10>): The lower bound.
end = param.Integer(allow_refs=False, default=1, inclusive_bounds=(True, True), label=’End’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16691d350>): The upper bound.
step = param.Integer(allow_refs=False, default=1, inclusive_bounds=(True, True), label=’Step’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1666f25d0>): The step size.
value_throttled = param.Integer(allow_None=True, allow_refs=False, constant=True, inclusive_bounds=(True, True), label=’Value throttled’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16691f190>): The value of the slider. Updated when the handle is released

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.JSONEditor(**params: Any)[source]#

Bases: Widget

The JSONEditor provides a visual editor for JSON-serializable datastructures, e.g. Python dictionaries and lists, with functionality for different editing modes, inserting objects and validation using JSON Schema.

Reference: https://panel.holoviz.org/reference/widgets/JSONEditor.html

Example:

>>> JSONEditor(value={
...     'dict'  : {'key': 'value'},
...     'float' : 3.14,
...     'int'   : 1,
...     'list'  : [1, 2, 3],
...     'string': 'A string',
... }, mode='code')

Parameters inherited from:

value = param.Parameter(allow_refs=False, default={}, label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x160409390>): JSON data to be edited.
menu = param.Boolean(allow_refs=False, default=True, label=’Menu’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1663cb690>): Adds main menu bar - Contains format, sort, transform, search etc. functionality. true by default. Applicable in all types of mode.
mode = param.Selector(allow_refs=False, default=’tree’, label=’Mode’, names={}, nested_refs=False, objects=[‘tree’, ‘view’, ‘form’, ‘text’, ‘preview’], rx=<param.reactive.reactive_ops object at 0x1663c87d0>): Sets the editor mode. In ‘view’ mode, the data and datastructure is read-only. In ‘form’ mode, only the value can be changed, the data structure is read-only. Mode ‘code’ requires the Ace editor to be loaded on the page. Mode ‘text’ shows the data as plain text. The ‘preview’ mode can handle large JSON documents up to 500 MiB. It shows a preview of the data, and allows to transform, sort, filter, format, or compact the data.
search = param.Boolean(allow_refs=False, default=True, label=’Search’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1663cae50>): Enables a search box in the upper right corner of the JSONEditor. true by default. Only applicable when mode is ‘tree’, ‘view’, or ‘form’.
selection = param.List(allow_refs=False, bounds=(0, None), default=[], label=’Selection’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1663c9e90>): Current selection.
schema = param.Dict(allow_None=True, allow_refs=False, class_=<class ‘dict’>, label=’Schema’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1663cb690>): Validate the JSON object against a JSON schema. A JSON schema describes the structure that a JSON object must have, like required properties or the type that a value must have. See http://json-schema.org/ for more information.
templates = param.List(allow_refs=False, bounds=(0, None), default=[], label=’Templates’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1663cb5d0>): Array of templates that will appear in the context menu, Each template is a json object precreated that can be added as a object value to any node in your document.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.LinearGauge(*, bounds, colors, default_color, format, horizontal, nan_format, needle_color, show_boundaries, tick_size, title_size, unfilled_color, value_size, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: ValueIndicator

A LinearGauge represents a value in some range as a position on an linear scale. It is similar to a Dial/Gauge but visually more compact.

Reference: https://panel.holoviz.org/reference/indicators/LinearGauge.html

Example:

>>> LinearGauge(value=30, default_color='red', bounds=(0, 100))

Parameters inherited from:

value = param.Number(allow_None=True, allow_refs=False, default=25, inclusive_bounds=(True, True), label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1662207d0>): Value to indicate on the dial a value within the declared bounds.
height = param.Integer(allow_refs=False, bounds=(1, None), default=300, inclusive_bounds=(True, True), label=’Height’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x161833b10>): The height of the component (in pixels). This can be either fixed or preferred height, depending on height sizing policy.
width = param.Integer(allow_refs=False, bounds=(1, None), default=125, inclusive_bounds=(True, True), label=’Width’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x166220450>): The width of the component (in pixels). This can be either fixed or preferred width, depending on width sizing policy.
bounds = param.Range(allow_refs=False, default=(0, 100), inclusive_bounds=(True, True), label=’Bounds’, length=2, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x161fe4c50>): The upper and lower bound of the gauge.
default_color = param.String(allow_refs=False, default=’lightblue’, label=’Default color’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x166220890>): Color of the radial annulus if not color thresholds are supplied.
colors = param.Parameter(allow_None=True, allow_refs=False, label=’Colors’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x161fe4290>): Color thresholds for the gauge, specified as a list of tuples of the fractional threshold and the color to switch to.
format = param.String(allow_refs=False, default=’{value:.2f}%’, label=’Format’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x166220390>): Formatting string for the value indicator and lower/upper bounds.
horizontal = param.Boolean(allow_refs=False, default=False, label=’Horizontal’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x161fe68d0>): Whether to display the linear gauge horizontally.
nan_format = param.String(allow_refs=False, default=’-’, label=’Nan format’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x166220390>): How to format nan values.
needle_color = param.String(allow_refs=False, default=’black’, label=’Needle color’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x161fe68d0>): Color of the gauge needle.
show_boundaries = param.Boolean(allow_refs=False, default=False, label=’Show boundaries’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x166220990>): Whether to show the boundaries between colored regions.
unfilled_color = param.String(allow_refs=False, default=’whitesmoke’, label=’Unfilled color’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x161fe4050>): Color of the unfilled region of the LinearGauge.
title_size = param.String(allow_None=True, allow_refs=False, label=’Title size’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1662203d0>): Font size of the gauge title.
tick_size = param.String(allow_None=True, allow_refs=False, label=’Tick size’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x161fe4150>): Font size of the gauge tick labels.
value_size = param.String(allow_None=True, allow_refs=False, label=’Value size’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1662203d0>): Font size of the gauge value label.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.LiteralInput(*, description, placeholder, serializer, type, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: Widget

The LiteralInput allows declaring Python literals using a text input widget.

A literal is some specific primitive value of type str , int, float, bool etc or a dict, list, tuple, set etc of primitive values.

Optionally the literal type may be declared.

Reference: https://panel.holoviz.org/reference/widgets/LiteralInput.html

Example:

>>> LiteralInput(name='Dictionary', value={'key': [1, 2, 3]}, type=dict)

Parameters inherited from:

value = param.Parameter(allow_None=True, allow_refs=False, label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x15f80a490>): The widget value which the widget type resolves to when used as a reactive param reference.
width = param.Integer(allow_None=True, allow_refs=False, bounds=(0, None), default=300, inclusive_bounds=(True, True), label=’Width’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x161eba110>): Width of this component. If sizing_mode is set to stretch or scale mode this will merely be used as a suggestion.
description = param.String(allow_None=True, allow_refs=False, label=’Description’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x161fed790>): An HTML string describing the function of this component.
placeholder = param.String(allow_refs=False, default=’’, label=’Placeholder’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x161ebbed0>): Placeholder for empty input field.
serializer = param.ObjectSelector(allow_refs=False, default=’ast’, label=’Serializer’, names={}, nested_refs=False, objects=[‘ast’, ‘json’], rx=<param.reactive.reactive_ops object at 0x161eb81d0>): The serialization (and deserialization) method to use. ‘ast’ uses ast.literal_eval and ‘json’ uses json.loads and json.dumps.

type = param.ClassSelector(allow_None=True, allow_refs=False, class_=(<class ‘type’>, <class ‘tuple’>), label=’Type’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x167f17b10>)

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.LoadingSpinner(*, bgcolor, color, size, throttle, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: BooleanIndicator

The LoadingSpinner is a boolean indicator providing a visual representation of the loading status.

If the value is set to True the spinner will rotate while setting it to False will disable the rotating segment.

Reference: https://panel.holoviz.org/reference/indicators/LoadingSpinner.html

Example:

>>> LoadingSpinner(value=True, color='primary', bgcolor='light', width=100, height=100)

Parameters inherited from:

value = param.Boolean(allow_refs=True, default=False, label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1619f9b10>): Whether the indicator is active or not.

bgcolor = param.ObjectSelector(allow_refs=True, default=’light’, label=’Bgcolor’, names={}, nested_refs=False, objects=[‘dark’, ‘light’], rx=<param.reactive.reactive_ops object at 0x16197fdd0>)

color = param.ObjectSelector(allow_refs=True, default=’dark’, label=’Color’, names={}, nested_refs=False, objects=[‘primary’, ‘secondary’, ‘success’, ‘info’, ‘danger’, ‘warning’, ‘light’, ‘dark’], rx=<param.reactive.reactive_ops object at 0x161932610>)

size = param.Integer(allow_refs=True, default=125, inclusive_bounds=(True, True), label=’Size’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x161931950>): Size of the spinner in pixels.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.MenuButton(*, clicked, items, split, button_style, button_type, icon, icon_size, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: _ButtonBase, _ClickButton, IconMixin

The MenuButton widget allows specifying a list of menu items to select from triggering events when the button is clicked.

Unlike other widgets, it does not have a value parameter. Instead it has a clicked parameter that can be watched to trigger events and which reports the last clicked menu item.

Reference: https://panel.holoviz.org/reference/widgets/MenuButton.html

Example:

>>> menu_items = [('Option A', 'a'), ('Option B', 'b'), None, ('Option C', 'c')]
>>> MenuButton(name='Dropdown', items=menu_items, button_type='primary')

Parameters inherited from:

clicked = param.String(allow_None=True, allow_refs=False, label=’Clicked’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1620384d0>): Last menu item that was clicked.
items = param.List(allow_refs=False, bounds=(0, None), default=[], label=’Items’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16212cdd0>): Menu items in the dropdown. Allows strings, tuples of the form (title, value) or Nones to separate groups of items.
split = param.Boolean(allow_refs=False, default=False, label=’Split’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x162039150>): Whether to add separate dropdown area to button.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

js_on_click(args: dict[str, Any] = {}, code: str = '') → Callback[source]#

Allows defining a JS callback to be triggered when the button is clicked.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
code: str: The Javascript code to execute when the button is clicked.

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a Javascript (JS) callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
**callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

on_click(callback: Callable[[Event], None]) → Watcher[source]#

Register a callback to be executed when the button is clicked.

The callback is given an Event argument declaring the number of clicks

Arguments#

callback: (Callable[[param.parameterized.Event], None]): The function to run on click events. Must accept a positional Event argument

Returns#

watcher: param.Parameterized.Watcher: A Watcher that executes the callback when the MenuButton is clicked.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.MultiChoice(*, delete_button, max_items, option_limit, placeholder, search_option_limit, solid, description, options, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: _MultiSelectBase

The MultiChoice widget allows selecting multiple values from a list of options.

It falls into the broad category of multi-value, option-selection widgets that provide a compatible API and include the MultiSelect, CrossSelector, CheckBoxGroup and CheckButtonGroup widgets.

The MultiChoice widget provides a much more compact UI than MultiSelect.

Reference: https://panel.holoviz.org/reference/widgets/MultiChoice.html

Example:

>>> MultiChoice(
...     name='Favourites', value=['Panel', 'hvPlot'],
...     options=['Panel', 'hvPlot', 'HoloViews', 'GeoViews', 'Datashader', 'Param', 'Colorcet'],
...     max_items=2
... )

Parameters inherited from:

width = param.Integer(allow_None=True, allow_refs=False, bounds=(0, None), default=300, inclusive_bounds=(True, True), label=’Width’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16a946850>): Width of this component. If sizing_mode is set to stretch or scale mode this will merely be used as a suggestion.
delete_button = param.Boolean(allow_refs=False, default=True, label=’Delete button’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16a948190>): Whether to display a button to delete a selected option.
max_items = param.Integer(allow_None=True, allow_refs=False, bounds=(1, None), inclusive_bounds=(True, True), label=’Max items’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16a946790>): Maximum number of options that can be selected.
option_limit = param.Integer(allow_None=True, allow_refs=False, bounds=(1, None), inclusive_bounds=(True, True), label=’Option limit’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16a948690>): Maximum number of options to display at once.
search_option_limit = param.Integer(allow_None=True, allow_refs=False, bounds=(1, None), inclusive_bounds=(True, True), label=’Search option limit’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16a946510>): Maximum number of options to display at once if search string is entered.
placeholder = param.String(allow_refs=False, default=’’, label=’Placeholder’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16a948110>): String displayed when no selection has been made.
solid = param.Boolean(allow_refs=False, default=True, label=’Solid’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16a945f10>): Whether to display widget with solid or light style.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.MultiSelect(*, size, description, options, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: _MultiSelectBase

The MultiSelect widget allows selecting multiple values from a list of options.

It falls into the broad category of multi-value, option-selection widgets that provide a compatible API and include the`CrossSelector`, CheckBoxGroup and CheckButtonGroup widgets.

Reference: https://panel.holoviz.org/reference/widgets/MultiSelect.html

Example:

>>> MultiSelect(
...     name='Frameworks', value=['Bokeh', 'Panel'],
...     options=['Bokeh', 'Dash', 'Panel', 'Streamlit', 'Voila'], size=8
... )

Parameters inherited from:

size = param.Integer(allow_refs=True, default=4, inclusive_bounds=(True, True), label=’Size’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16a966f10>): The number of items displayed at once (i.e. determines the widget height).

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

on_double_click(callback: Callable[[Event], None | Awaitable[None]]) → Watcher[source]#

Register a callback to be executed when a MultiSelect option is double-clicked.

The callback is given an DoubleClickEvent argument

Example#

>>> select = pn.widgets.MultiSelect(options=["A", "B", "C"])
>>> def handle_click(event):
...    print(f"Option {event.option} was double clicked.")
>>> select.on_double_click(handle_click)

Arguments#

callback:: The function to run on click events. Must accept a positional Event argument. Can be a sync or async function

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.NestedSelect(*, _levels, _max_depth, _widgets, layout, levels, options, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: CompositeWidget

The NestedSelect widget is composed of multiple widgets, where subsequent select options depend on the parent’s value.

Reference: https://panel.holoviz.org/reference/widgets/NestedSelect.html

Example:

>>> NestedSelect(
...     options={
...         "gfs": {"tmp": [1000, 500], "pcp": [1000]},
...         "name": {"tmp": [1000, 925, 850, 700, 500], "pcp": [1000]},
...     },
...     levels=["model", "var", "level"],
... )

Parameters inherited from:

value = param.Dict(allow_None=True, allow_refs=False, class_=<class ‘dict’>, label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16a98e7d0>): The value from all the Select widgets; the keys are the levels names. If no levels names are specified, the keys are the levels indices.
disabled = param.Boolean(allow_refs=False, default=False, label=’Disabled’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16a98ff10>): Whether the widget is disabled.
options = param.ClassSelector(allow_None=True, allow_refs=False, class_=(<class ‘dict’>, <class ‘function’>), label=’Options’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16a98e210>): The options to select from. The options may be nested dictionaries, lists, or callables that return those types. If callables are used, the callables must accept level and value keyword arguments, where level is the level that updated and value is a dictionary of the current values, containing keys up to the level that was updated.
layout = param.Parameter(allow_refs=False, default=<class ‘panel.layout.base.Column’>, label=’Layout’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16a98fe50>): The layout type of the widgets. If a dictionary, a “type” key can be provided, to specify the layout type of the widgets, and any additional keyword arguments will be used to instantiate the layout.
levels = param.List(allow_refs=False, bounds=(0, None), default=[], label=’Levels’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16a98e7d0>): Either a list of strings or a list of dictionaries. If a list of strings, the strings are used as the names of the levels. If a list of dictionaries, each dictionary may have a “name” key, which is used as the name of the level, a “type” key, which is used as the type of widget, and any corresponding widget keyword arguments. Must be specified if options is callable.
_widgets = param.List(allow_refs=False, bounds=(0, None), default=[], label=’ widgets’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16a98e3d0>): The nested select widgets.
_max_depth = param.Integer(allow_refs=False, default=0, inclusive_bounds=(True, True), label=’ max depth’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16a984390>): The number of levels of the nested select widgets.
_levels = param.List(allow_refs=False, bounds=(0, None), default=[], label=’ levels’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16a98e3d0>): The internal rep of levels to prevent overwriting user provided levels.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

layout[source]#: alias of Column

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.Number(*, colors, default_color, font_size, format, nan_format, title_size, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: ValueIndicator

The Number indicator renders the value as text optionally colored according to the colors thresholds.

Reference: https://panel.holoviz.org/reference/indicators/Number.html

Example:

>>> Number(name='Rate', value=72, format='{value}%', colors=[(80, 'green'), (100, 'red')]

Parameters inherited from:

default_color = param.String(allow_refs=False, default=’black’, label=’Default color’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16a9b3c50>): The color of the Number indicator if no colors are provided
colors = param.List(allow_None=True, allow_refs=False, bounds=(0, None), label=’Colors’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16a9a5590>): Color thresholds for the Number indicator, specified as a tuple of the absolute thresholds and the color to switch to.
format = param.String(allow_refs=False, default=’{value}’, label=’Format’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16a9b3b90>): A formatter string which accepts a {value}.
font_size = param.String(allow_refs=False, default=’54pt’, label=’Font size’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16a9a5010>): The size of number itself.
nan_format = param.String(allow_refs=False, default=’-’, label=’Nan format’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16a9b3cd0>): How to format nan values.
title_size = param.String(allow_refs=False, default=’18pt’, label=’Title size’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16a9a5690>): The size of the title given by the name.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.NumberInput(*, page_step_multiplier, wheel_wait, description, end, format, placeholder, start, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: _SpinnerBase

Parameters inherited from:

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.PasswordInput(**params: Any)[source]#

Bases: _TextInputBase

The PasswordInput allows entering any string using an obfuscated text input box.

Reference: https://panel.holoviz.org/reference/widgets/PasswordInput.html

Example:

>>> PasswordInput(
...     name='Password', placeholder='Enter your password here...'
... )

Parameters inherited from:

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, onkeyup=False, **params) → Viewable[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.
onkeyup: boolean: Whether to trigger events on every key press.
params: dict: Keyword arguments to be passed to the widget constructor

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.Player(*, end, start, value_throttled, direction, interval, loop_policy, preview_duration, scale_buttons, show_loop_controls, show_value, step, value_align, visible_buttons, visible_loop_options, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: PlayerBase

The Player provides controls to play and skip through a number of frames defined by explicit start and end values. The speed at which the widget plays is defined by the interval (in milliseconds), but it is also possible to skip frames using the step parameter.

Reference: https://panel.holoviz.org/reference/widgets/Player.html

Example:

>>> Player(name='Player', start=0, end=100, value=32, loop_policy='loop', value_align='top_center')

Parameters inherited from:

value = param.Integer(allow_refs=False, default=0, inclusive_bounds=(True, True), label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ab0d750>): Current player value
start = param.Integer(allow_refs=False, default=0, inclusive_bounds=(True, True), label=’Start’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ab0f550>): Lower bound on the slider value
end = param.Integer(allow_refs=False, default=10, inclusive_bounds=(True, True), label=’End’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ab0d690>): Upper bound on the slider value
value_throttled = param.Integer(allow_refs=False, constant=True, default=0, inclusive_bounds=(True, True), label=’Value throttled’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ab0f490>): Current throttled player value.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.Progress(*, active, bar_color, max, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: ValueIndicator

The Progress widget displays the progress towards some target based on the current value and the max value.

If no value is set, the Progress widget is in indeterminate mode and will animate depending on whether it is active or not. A more beautiful indicator for this use case is the LoadingSpinner.

Reference: https://panel.holoviz.org/reference/indicators/Progress.html

Example:

>>> Progress(value=20, max=100, bar_color="primary")

Parameters inherited from:

value = param.Integer(allow_refs=False, bounds=(-1, None), default=-1, inclusive_bounds=(True, True), label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ab2a2d0>): The current value of the progress bar. If set to -1 the progress bar will be indeterminate and animate depending on the active parameter.
width = param.Integer(allow_refs=False, bounds=(0, None), default=300, inclusive_bounds=(True, True), label=’Width’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ab1c110>): The width of the component (in pixels). This can be either fixed or preferred width, depending on width sizing policy.
sizing_mode = param.ObjectSelector(allow_refs=False, label=’Sizing mode’, names={}, nested_refs=False, objects=[‘fixed’, ‘stretch_width’, ‘stretch_height’, ‘stretch_both’, ‘scale_width’, ‘scale_height’, ‘scale_both’, None], rx=<param.reactive.reactive_ops object at 0x16ab29c90>): How the component should size itself. This is a high-level setting for maintaining width and height of the component. To gain more fine grained control over sizing, use width_policy, height_policy and aspect_ratio instead (those take precedence over sizing_mode). "fixed" Component is not responsive. It will retain its original width and height regardless of any subsequent browser window resize events. "stretch_width" Component will responsively resize to stretch to the available width, without maintaining any aspect ratio. The height of the component depends on the type of the component and may be fixed or fit to component’s contents. "stretch_height" Component will responsively resize to stretch to the available height, without maintaining any aspect ratio. The width of the component depends on the type of the component and may be fixed or fit to component’s contents. "stretch_both" Component is completely responsive, independently in width and height, and will occupy all the available horizontal and vertical space, even if this changes the aspect ratio of the component. "scale_width" Component will responsively resize to stretch to the available width, while maintaining the original or provided aspect ratio. "scale_height" Component will responsively resize to stretch to the available height, while maintaining the original or provided aspect ratio. "scale_both" Component will responsively resize to both the available width and height, while maintaining the original or provided aspect ratio.
active = param.Boolean(allow_refs=False, default=True, label=’Active’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ab2b810>): If no value is set the active property toggles animation of the progress bar on and off.

bar_color = param.ObjectSelector(allow_refs=False, default=’success’, label=’Bar color’, names={}, nested_refs=False, objects=[‘primary’, ‘secondary’, ‘success’, ‘info’, ‘danger’, ‘warning’, ‘light’, ‘dark’], rx=<param.reactive.reactive_ops object at 0x16ab29c90>)

max = param.Integer(allow_refs=False, default=100, inclusive_bounds=(True, True), label=’Max’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ab2a210>): The maximum value of the progress bar.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

sizing_mode = None#

class panel.widgets.RadioBoxGroup(*, inline, options, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: _RadioGroupBase

The RadioBoxGroup widget allows selecting from a list or dictionary of values using a set of checkboxes.

It falls into the broad category of single-value, option-selection widgets that provide a compatible API and include the RadioButtonGroup, Select and DiscreteSlider widgets.

Reference: https://panel.holoviz.org/reference/widgets/RadioBoxGroup.html

Example:

>>> RadioBoxGroup(
...     name='Sponsor', options=['Anaconda', 'Blackstone'], inline=True
... )

Parameters inherited from:

inline = param.Boolean(allow_refs=False, default=False, label=’Inline’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ab52190>): Whether the items be arrange vertically (False) or horizontally in-line (True).

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.RadioButtonGroup(*, orientation, options, button_style, button_type, description, description_delay, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: _RadioGroupBase, _ButtonBase, TooltipMixin

The RadioButtonGroup widget allows selecting from a list or dictionary of values using a set of toggle buttons.

It falls into the broad category of single-value, option-selection widgets that provide a compatible API and include the RadioBoxGroup, Select, and DiscreteSlider widgets.

Reference: https://panel.holoviz.org/reference/widgets/RadioButtonGroup.html

Example:

>>> RadioButtonGroup(
...     name='Plotting library', options=['Matplotlib', 'Bokeh', 'Plotly'],
...     button_type='success'
... )

Parameters inherited from:

orientation = param.Selector(allow_refs=False, default=’horizontal’, label=’Orientation’, names={}, nested_refs=False, objects=[‘horizontal’, ‘vertical’], rx=<param.reactive.reactive_ops object at 0x16ab6d490>): Button group orientation, either ‘horizontal’ (default) or ‘vertical’.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.RangeSlider(*, end, format, start, step, value_throttled, bar_color, direction, orientation, show_value, tooltips, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: _RangeSliderBase

The RangeSlider widget allows selecting a floating-point range using a slider with two handles.

Reference: https://panel.holoviz.org/reference/widgets/RangeSlider.html

Example:

>>> RangeSlider(
...     value=(1.0, 1.5), start=0.0, end=2.0, step=0.25, name="A tuple of floats"
... )

Parameters inherited from:

value = param.Range(allow_refs=False, default=(0, 1), inclusive_bounds=(True, True), label=’Value’, length=2, nested_refs=True, rx=<param.reactive.reactive_ops object at 0x16ab99b10>): The selected range as a tuple of values. Updated when a handle is dragged.
value_start = param.Number(allow_refs=False, constant=True, default=0, inclusive_bounds=(True, True), label=’Value start’, nested_refs=False, readonly=True, rx=<param.reactive.reactive_ops object at 0x16ab77790>): The lower value of the selected range.
value_end = param.Number(allow_refs=False, constant=True, default=1, inclusive_bounds=(True, True), label=’Value end’, nested_refs=False, readonly=True, rx=<param.reactive.reactive_ops object at 0x16ab99450>): The upper value of the selected range.
value_throttled = param.Range(allow_None=True, allow_refs=False, constant=True, inclusive_bounds=(True, True), label=’Value throttled’, length=2, nested_refs=True, rx=<param.reactive.reactive_ops object at 0x16ab9aa90>): The selected range as a tuple of floating point values. Updated when a handle is released
start = param.Number(allow_refs=False, default=0, inclusive_bounds=(True, True), label=’Start’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ab999d0>): The lower bound.
end = param.Number(allow_refs=False, default=1, inclusive_bounds=(True, True), label=’End’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ab9aa10>): The upper bound.
step = param.Number(allow_refs=False, default=0.1, inclusive_bounds=(True, True), label=’Step’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ab99790>): The step size.
format = param.ClassSelector(allow_None=True, allow_refs=False, class_=(<class ‘str’>, <class ‘bokeh.models.formatters.TickFormatter’>), label=’Format’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ab9a090>): A format string or bokeh TickFormatter.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.Select(*, description, disabled_options, groups, size, options, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: SingleSelectBase

The Select widget allows selecting a value from a list or dictionary of options by selecting it from a dropdown menu or selection area.

It falls into the broad category of single-value, option-selection widgets that provide a compatible API and include the RadioBoxGroup, AutocompleteInput and DiscreteSlider widgets.

Reference: https://panel.holoviz.org/reference/widgets/Select.html

Example:

>>> Select(name='Study', options=['Biology', 'Chemistry', 'Physics'])

Parameters inherited from:

width = param.Integer(allow_None=True, allow_refs=False, bounds=(0, None), default=300, inclusive_bounds=(True, True), label=’Width’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16aba9090>): Width of this component. If sizing_mode is set to stretch or scale mode this will merely be used as a suggestion.
description = param.String(allow_None=True, allow_refs=False, label=’Description’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16abaaa10>): An HTML string describing the function of this component.
disabled_options = param.List(allow_refs=False, bounds=(0, None), default=[], label=’Disabled options’, nested_refs=True, rx=<param.reactive.reactive_ops object at 0x16aba8850>): Optional list of options that are disabled, i.e. unusable and un-clickable. If options is a dictionary the list items must be dictionary values.
groups = param.Dict(allow_None=True, allow_refs=False, class_=<class ‘dict’>, label=’Groups’, nested_refs=True, rx=<param.reactive.reactive_ops object at 0x16abaaa90>): Dictionary whose keys are used to visually group the options and whose values are either a list or a dictionary of options to select from. Mutually exclusive with options and valid only if size is 1.
size = param.Integer(allow_refs=False, bounds=(1, None), default=1, inclusive_bounds=(True, True), label=’Size’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16aba9090>): Declares how many options are displayed at the same time. If set to 1 displays options as dropdown otherwise displays scrollable area.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.SpeechToText(*, _grammars, abort, audio_started, button_hide, button_not_started, button_started, button_type, continuous, grammars, interim_results, lang, max_alternatives, results, service_uri, sound_started, speech_started, start, started, stop, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: Widget

The SpeechToText widget controls the speech recognition service of the browser.

It wraps the HTML5 SpeechRecognition API. See https://developer.mozilla.org/en-US/docs/Web/API/SpeechRecognition

Reference: https://panel.holoviz.org/reference/widgets/SpeechToText.html

Example:

>>> SpeechToText(button_type="light")

This functionality is experimental and only supported by Chrome and a few other browsers. Checkout https://caniuse.com/speech-recognition for a up to date list of browsers supporting the SpeechRecognition Api. Or alternatively https://developer.mozilla.org/en-US/docs/Web/API/SpeechRecognition#Browser_compatibility

On some browsers, like Chrome, using Speech Recognition on a web page involves a server-based recognition engine. Your audio is sent to a web service for recognition processing, so it won’t work offline. Whether this is secure and confidential enough for your use case is up to you to evaluate.

Parameters inherited from:

value = param.String(allow_refs=False, constant=True, default=’’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16abd9790>): The transcipt of the highest confidence RecognitionAlternative of the last RecognitionResult. Please note we strip the transcript for leading spaces.
abort = param.Event(allow_refs=False, default=False, label=’Abort’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16abdaf90>): Stops the speech recognition service from listening to incoming audio, and doesn’t attempt to return a RecognitionResult.
start = param.Event(allow_refs=False, default=False, label=’Start’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16abd9790>): Starts the speech recognition service listening to incoming audio with intent to recognize grammars associated with the current SpeechRecognition.
stop = param.Event(allow_refs=False, default=False, label=’Stop’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16abdaed0>): Stops the speech recognition service from listening to incoming audio, and attempts to return a RecognitionResult using the audio captured so far.
lang = param.ObjectSelector(allow_None=True, allow_refs=False, default=’’, names={}, nested_refs=False, objects=[‘’, ‘af-ZA’, ‘ar-AE’, ‘ar-BH’, ‘ar-DZ’, ‘ar-EG’, ‘ar-IL’, ‘ar-IQ’, ‘ar-JO’, ‘ar-KW’, ‘ar-LB’, ‘ar-MA’, ‘ar-OM’, ‘ar-PS’, ‘ar-QA’, ‘ar-SA’, ‘ar-TN’, ‘bg-BG’, ‘ca-ES’, ‘cmn-Hans-CN’, ‘cmn-Hans-HK’, ‘cmn-Hant-TW’, ‘cs-CZ’, ‘da-DK’, ‘de-DE’, ‘el-GR’, ‘en-AU’, ‘en-CA’, ‘en-GB’, ‘en-IE’, ‘en-IN’, ‘en-NZ’, ‘en-PH’, ‘en-US’, ‘en-ZA’, ‘es-AR’, ‘es-BO’, ‘es-CL’, ‘es-CO’, ‘es-CR’, ‘es-DO’, ‘es-EC’, ‘es-ES’, ‘es-GT’, ‘es-HN’, ‘es-MX’, ‘es-NI’, ‘es-PA’, ‘es-PE’, ‘es-PR’, ‘es-PY’, ‘es-SV’, ‘es-US’, ‘es-UY’, ‘es-VE’, ‘eu-ES’, ‘fa-IR’, ‘fi-FI’, ‘fil-PH’, ‘fr-FR’, ‘gl-ES’, ‘he-IL’, ‘hi-IN’, ‘hr_HR’, ‘hu-HU’, ‘id-ID’, ‘is-IS’, ‘it-CH’, ‘it-IT’, ‘ja-JP’, ‘ko-KR’, ‘lt-LT’, ‘ms-MY’, ‘nb-NO’, ‘nl-NL’, ‘pl-PL’, ‘pt-BR’, ‘pt-PT’, ‘ro-RO’, ‘ru-RU’, ‘sk-SK’, ‘sl-SI’, ‘sr-RS’, ‘sv-SE’, ‘th-TH’, ‘tr-TR’, ‘uk-UA’, ‘vi-VN’, ‘yue-Hant-HK’, ‘zu-ZA’], rx=<param.reactive.reactive_ops object at 0x16abdaf90>): The language of the current SpeechRecognition in BCP 47 format. For example ‘en-US’. If not specified, this defaults to the HTML lang attribute value, or the user agent’s language setting if that isn’t set either.
continuous = param.Boolean(allow_refs=False, default=False, label=’Continuous’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16abdac50>): Controls whether continuous results are returned for each recognition, or only a single result. Defaults to False
interim_results = param.Boolean(allow_refs=False, default=False, label=’Interim results’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16abd9450>): Controls whether interim results should be returned (True) or not (False.) Interim results are results that are not yet final (e.g. the RecognitionResult.is_final property is False).
max_alternatives = param.Integer(allow_refs=False, bounds=(1, 5), default=1, inclusive_bounds=(True, True), label=’Max alternatives’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16abdb390>): Sets the maximum number of RecognitionAlternatives provided per result. A number between 1 and 5. The default value is 1.
service_uri = param.String(allow_refs=False, default=’’, label=’Service uri’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16abd9790>): Specifies the location of the speech recognition service used by the current SpeechRecognition to handle the actual recognition. The default is the user agent’s default speech service.
grammars = param.ClassSelector(allow_None=True, allow_refs=False, class_=<class ‘panel.widgets.speech_to_text.GrammarList’>, label=’Grammars’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16abdb090>): A GrammarList object that represents the grammars that will be understood by the current SpeechRecognition service
button_hide = param.Boolean(allow_refs=False, default=False, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16abd9450>): If True no button is shown. If False a toggle Start/ Stop button is shown.
button_type = param.ObjectSelector(allow_refs=False, default=’light’, label=’Button type’, names={}, nested_refs=False, objects=[‘default’, ‘primary’, ‘success’, ‘warning’, ‘danger’, ‘light’, ‘light’, ‘dark’], rx=<param.reactive.reactive_ops object at 0x16abdb010>): The button styling.
button_not_started = param.String(allow_refs=False, default=’’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16abd9450>): The text to show on the button when the SpeechRecognition service is NOT started. If ‘’ a muted microphone icon is shown.
button_started = param.String(allow_refs=False, default=’’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16abdb250>): The text to show on the button when the SpeechRecognition service is started. If ‘’ a muted microphone icon is shown.
started = param.Boolean(allow_refs=False, constant=True, default=False, label=’Started’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16abdb2d0>): Returns True if the Speech Recognition Service is started and False otherwise.
audio_started = param.Boolean(allow_refs=False, constant=True, default=False, label=’Audio started’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16abdaad0>): Returns True if the Audio is started and False otherwise.
sound_started = param.Boolean(allow_refs=False, constant=True, default=False, label=’Sound started’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16abdb010>): Returns True if the Sound is started and False otherwise.
speech_started = param.Boolean(allow_refs=False, constant=True, default=False, label=’Speech started’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16abdaed0>): Returns True if the the User has started speaking and False otherwise.
results = param.List(allow_refs=False, bounds=(0, None), constant=True, default=[], label=’Results’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16abdb650>): The results as a list of Dictionaries.
_grammars = param.List(allow_refs=False, bounds=(0, None), constant=True, default=[], label=’ grammars’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16abdac50>): List used to transfer the serialized grammars from server to browser.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

property results_as_html: str#

Returns the results formatted as html

Convenience method for ease of use

property results_deserialized#: Returns the results as a List of RecognitionResults

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

panel.widgets.Spinner[source]#: alias of NumberInput

class panel.widgets.StaticText(**params: Any)[source]#

Bases: Widget

The StaticText widget displays a text value, but does not allow editing it.

Reference: https://panel.holoviz.org/reference/widgets/StaticText.html

Example:

>>> StaticText(name='Model', value='animagen2')

Parameters inherited from:

value = param.Parameter(allow_None=True, allow_refs=False, label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16abea690>): The current value to be displayed.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.Switch(**params: Any)[source]#

Bases: _BooleanWidget

The Switch allows toggling a single condition between True/False states by ticking a checkbox.

This widget is interchangeable with the Toggle widget.

Reference: https://panel.holoviz.org/reference/widgets/Switch.html

Example:

>>> Switch(name='Works with the tools you know and love', value=True)

Parameters inherited from:

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.Tabulator(value=None, **params)[source]#

Bases: BaseTable

The Tabulator widget wraps the [Tabulator js](http://tabulator.info/) table to provide a full-featured, very powerful interactive table.

Reference: https://panel.holoviz.org/reference/widgets/Tabulator.html

Example:

>>> Tabulator(df, theme='site', pagination='remote', page_size=25)

Parameters inherited from:

selection = param._ListValidateWithCallable(allow_refs=True, bounds=(0, None), default=[], item_type=<class ‘int’>, label=’Selection’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ac3bbd0>): The currently selected rows of the table. It validates its values against ‘selectable_rows’ if used.
row_height = param.Integer(allow_refs=True, default=30, inclusive_bounds=(True, True), label=’Row height’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ac41850>): The height of each table row.
buttons = param.Dict(allow_refs=True, class_=<class ‘dict’>, default={}, label=’Buttons’, nested_refs=True, rx=<param.reactive.reactive_ops object at 0x16ac387d0>): Dictionary mapping from column name to a HTML element to use as the button icon.
expanded = param.List(allow_refs=True, bounds=(0, None), default=[], label=’Expanded’, nested_refs=True, rx=<param.reactive.reactive_ops object at 0x16ac41010>): List of expanded rows, only applicable if a row_content function has been defined.
embed_content = param.Boolean(allow_refs=True, default=False, label=’Embed content’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ac3a810>): Whether to embed the row_content or render it dynamically when a row is expanded.
filters = param.List(allow_refs=True, bounds=(0, None), default=[], label=’Filters’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ac40f10>): List of client-side filters declared as dictionaries containing ‘field’, ‘type’ and ‘value’ keys.
frozen_columns = param.ClassSelector(allow_refs=True, class_=(<class ‘list’>, <class ‘dict’>), default=[], label=’Frozen columns’, nested_refs=True, rx=<param.reactive.reactive_ops object at 0x16ac3a810>): One of: - List indicating the columns to freeze. The column(s) may be selected by name or index. - Dict indicating columns to freeze as keys and their freeze location as values, freeze location is either ‘right’ or ‘left’.
frozen_rows = param.List(allow_refs=True, bounds=(0, None), default=[], label=’Frozen rows’, nested_refs=True, rx=<param.reactive.reactive_ops object at 0x16ac40dd0>): List indicating the rows to freeze. If set, the first N rows will be frozen, which prevents them from scrolling out of frame; if set to a negative value the last N rows will be frozen.
groups = param.Dict(allow_refs=True, class_=<class ‘dict’>, default={}, label=’Groups’, nested_refs=True, rx=<param.reactive.reactive_ops object at 0x16ac20e50>): Dictionary mapping defining the groups.
groupby = param.List(allow_refs=True, bounds=(0, None), default=[], label=’Groupby’, nested_refs=True, rx=<param.reactive.reactive_ops object at 0x16ac41010>): Groups rows in the table by one or more columns.
header_align = param.ClassSelector(allow_refs=True, class_=(<class ‘dict’>, <class ‘str’>), default={}, label=’Header align’, nested_refs=True, rx=<param.reactive.reactive_ops object at 0x16ac20e50>): A mapping from column name to alignment or a fixed column alignment, which should be one of ‘left’, ‘center’, ‘right’.
header_filters = param.ClassSelector(allow_None=True, allow_refs=True, class_=(<class ‘bool’>, <class ‘dict’>), label=’Header filters’, nested_refs=True, rx=<param.reactive.reactive_ops object at 0x16ac41190>): Whether to enable filters in the header or dictionary configuring filters for each column.
header_tooltips = param.Dict(allow_refs=True, class_=<class ‘dict’>, default={}, label=’Header tooltips’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ac20e50>): Dictionary mapping from column name to a tooltip to show when hovering over the column header.
hidden_columns = param.List(allow_refs=True, bounds=(0, None), default=[], label=’Hidden columns’, nested_refs=True, rx=<param.reactive.reactive_ops object at 0x16ac41210>): List of columns to hide.

layout = param.ObjectSelector(allow_refs=True, default=’fit_data_table’, label=’Layout’, names={}, nested_refs=False, objects=[‘fit_data’, ‘fit_data_fill’, ‘fit_data_stretch’, ‘fit_data_table’, ‘fit_columns’], rx=<param.reactive.reactive_ops object at 0x16ac20e50>)

initial_page_size = param.Integer(allow_refs=True, bounds=(1, None), default=20, inclusive_bounds=(True, True), label=’Initial page size’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ac40090>): Initial page size if page_size is None and therefore automatically set.

pagination = param.ObjectSelector(allow_None=True, allow_refs=True, label=’Pagination’, names={}, nested_refs=False, objects=[‘local’, ‘remote’], rx=<param.reactive.reactive_ops object at 0x16ac20e10>)

page = param.Integer(allow_refs=True, default=1, inclusive_bounds=(True, True), label=’Page’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ac41390>): Currently selected page (indexed starting at 1), if pagination is enabled.
page_size = param.Integer(allow_None=True, allow_refs=True, bounds=(1, None), inclusive_bounds=(True, True), label=’Page size’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ac41bd0>): Number of rows to render per page, if pagination is enabled.
row_content = param.Callable(allow_None=True, allow_refs=True, label=’Row content’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ac40cd0>): A function which is given the DataFrame row and should return a Panel object to render as additional detail below the row.
selectable = param.ClassSelector(allow_refs=True, class_=(<class ‘bool’>, <class ‘str’>, <class ‘int’>), default=True, label=’Selectable’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ac20e50>): Defines the selection mode of the Tabulator. - True Selects rows on click. To select multiple use Ctrl-select, to select a range use Shift-select - False Disables selection - ‘checkbox’ Adds a column of checkboxes to toggle selections - ‘checkbox-single’ Same as ‘checkbox’ but header does not allow select/deselect all - ‘toggle’ Selection toggles when clicked - int The maximum number of selectable rows.
selectable_rows = param.Callable(allow_None=True, allow_refs=True, label=’Selectable rows’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ac41190>): A function which given a DataFrame should return a list of rows by integer index, which are selectable.
sortable = param.ClassSelector(allow_refs=True, class_=(<class ‘bool’>, <class ‘dict’>), default=True, label=’Sortable’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ac20e50>): Whether the columns in the table should be sortable. Can either be specified as a simple boolean toggling the behavior on and off or as a dictionary specifying the option per column.
theme = param.ObjectSelector(allow_refs=True, default=’simple’, label=’Theme’, names={}, nested_refs=False, objects=[‘default’, ‘site’, ‘simple’, ‘midnight’, ‘modern’, ‘bootstrap’, ‘bootstrap4’, ‘materialize’, ‘bulma’, ‘semantic-ui’, ‘fast’, ‘bootstrap5’], rx=<param.reactive.reactive_ops object at 0x16ac40cd0>): Tabulator CSS theme to apply to table.
theme_classes = param.List(allow_refs=True, bounds=(0, None), class_=<class ‘str’>, default=[], item_type=<class ‘str’>, label=’Theme classes’, nested_refs=True, rx=<param.reactive.reactive_ops object at 0x16ac20e50>): List of extra CSS classes to apply to the Tabulator element to customize the theme.
title_formatters = param.Dict(allow_refs=True, class_=<class ‘dict’>, default={}, label=’Title formatters’, nested_refs=True, rx=<param.reactive.reactive_ops object at 0x16ac41190>): Tabulator formatter specification to use for a particular column header title.

add_filter(filter, column=None)[source]#

Adds a filter to the table which can be a static value or dynamic parameter based object which will automatically update the table when changed..

When a static value, widget or parameter is supplied the filtering will follow a few well defined behaviors:

Arguments#

filter: Widget, param.Parameter or FunctionType: The value by which to filter the DataFrame along the declared column, or a function accepting the DataFrame to be filtered and returning a filtered copy of the DataFrame.
column: str or None: Column to which the filter will be applied, if the filter is a constant value, widget or parameter.

Raises#

ValueError: If the filter type is not supported or no column: was declared.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

property current_view: pd.DataFrame#: Returns the current view of the table after filtering and sorting are applied.

download(filename: str = 'table.csv')[source]#

Triggers downloading of the table as a CSV or JSON.

Arguments#

filename: str: The filename to save the table as.

download_menu(text_kwargs={}, button_kwargs={})[source]#

Returns a menu containing a TextInput and Button widget to set the filename and trigger a client-side download of the data.

Arguments#

text_kwargs: dict: Keyword arguments passed to the TextInput constructor
button_kwargs: dict: Keyword arguments passed to the Button constructor

Returns#

filename: TextInput: The TextInput widget setting a filename.
button: Button: The Button that triggers a download.

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

on_click(callback: Callable[[CellClickEvent], None], column: str | None = None)[source]#

Register a callback to be executed when any cell is clicked. The callback is given a CellClickEvent declaring the column and row of the cell that was clicked.

Arguments#

callback: (callable): The callback to run on edit events.
column: (str): Optional argument restricting the callback to a specific column.

on_edit(callback: Callable[[TableEditEvent], None])[source]#

Register a callback to be executed when a cell is edited. Whenever a cell is edited on_edit callbacks are called with a TableEditEvent as the first argument containing the column, row and value of the edited cell.

Arguments#

callback: (callable): The callback to run on edit events.

patch(patch_value, as_index=True)[source]#

Efficiently patches (updates) the existing value with the patch_value.

Arguments#

patch_value: (pd.DataFrame | pd.Series | Dict): The value(s) to patch the existing value with.
as_index: boolean: Whether to treat the patch index as DataFrame indexes (True) or as simple integer index.

Raises#

ValueError: Raised if the patch_value is not a supported type.

Examples#

Patch a DataFrame with a Dictionary row. >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> tabulator = Tabulator(value=value) >>> patch_value = {“x”: [(0, 3)]} >>> tabulator.patch(patch_value) >>> tabulator.value.to_dict(“list”) {‘x’: [3, 2], ‘y’: [‘a’, ‘b’]}

Patch a Dataframe with a Dictionary of Columns. >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> tabulator = Tabulator(value=value) >>> patch_value = {“x”: [(slice(2), (3,4))], “y”: [(1,’d’)]} >>> tabulator.patch(patch_value) >>> tabulator.value.to_dict(“list”) {‘x’: [3, 4], ‘y’: [‘a’, ‘d’]}

Patch a DataFrame with a Series. Please note the index is used in the update. >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> tabulator = Tabulator(value=value) >>> patch_value = pd.Series({“index”: 1, “x”: 4, “y”: “d”}) >>> tabulator.patch(patch_value) >>> tabulator.value.to_dict(“list”) {‘x’: [1, 4], ‘y’: [‘a’, ‘d’]}

Patch a Dataframe with a Dataframe. Please note the index is used in the update. >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> tabulator = Tabulator(value=value) >>> patch_value = pd.DataFrame({“x”: [3, 4], “y”: [“c”, “d”]}) >>> tabulator.patch(patch_value) >>> tabulator.value.to_dict(“list”) {‘x’: [3, 4], ‘y’: [‘c’, ‘d’]}

remove_filter(filter)[source]#: Removes a filter which was previously added.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

property selected_dataframe#: Returns a DataFrame of the currently selected rows.

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

stream(stream_value, rollover=None, reset_index=True, follow=True)[source]#

Streams (appends) the stream_value provided to the existing value in an efficient manner.

Arguments#

stream_value: (pd.DataFrame | pd.Series | Dict): The new value(s) to append to the existing value.
rollover: int: A maximum column size, above which data from the start of the column begins to be discarded. If None, then columns will continue to grow unbounded.
reset_index: (bool, default=True): If True and the stream_value is a DataFrame, then its index is reset. Helps to keep the index unique and named index

Raises#

ValueError: Raised if the stream_value is not a supported type.

Examples#

Stream a Series to a DataFrame >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> tabulator = Tabulator(value=value) >>> stream_value = pd.Series({“x”: 4, “y”: “d”}) >>> tabulator.stream(stream_value) >>> tabulator.value.to_dict(“list”) {‘x’: [1, 2, 4], ‘y’: [‘a’, ‘b’, ‘d’]}

Stream a Dataframe to a Dataframe >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> tabulator = Tabulator(value=value) >>> stream_value = pd.DataFrame({“x”: [3, 4], “y”: [“c”, “d”]}) >>> tabulator.stream(stream_value) >>> tabulator.value.to_dict(“list”) {‘x’: [1, 2, 3, 4], ‘y’: [‘a’, ‘b’, ‘c’, ‘d’]}

Stream a Dictionary row to a DataFrame >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> tabulator = Tabulator(value=value) >>> stream_value = {“x”: 4, “y”: “d”} >>> tabulator.stream(stream_value) >>> tabulator.value.to_dict(“list”) {‘x’: [1, 2, 4], ‘y’: [‘a’, ‘b’, ‘d’]}

Stream a Dictionary of Columns to a Dataframe >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> tabulator = Tabulator(value=value) >>> stream_value = {“x”: [3, 4], “y”: [“c”, “d”]} >>> tabulator.stream(stream_value) >>> tabulator.value.to_dict(“list”) {‘x’: [1, 2, 3, 4], ‘y’: [‘a’, ‘b’, ‘c’, ‘d’]}

class panel.widgets.Terminal(output=None, **params)[source]#

Bases: Widget

The Terminal widget renders a live terminal in the browser using the xterm.js library making it possible to display logs or even provide an interactive terminal in a Panel application.

Reference: https://panel.holoviz.org/reference/widgets/Terminal.html

Example:

>>> Terminal(
...     "Welcome to the Panel Terminal!", options={"cursorBlink": True}
... )

Parameters inherited from:

value = param.String(allow_refs=False, constant=True, default=’’, nested_refs=False, readonly=True, rx=<param.reactive.reactive_ops object at 0x16ac66590>): User input received from the Terminal. Sent one character at the time.
clear = param.Action(allow_None=True, allow_refs=False, constant=True, label=’Clear’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ac67bd0>): Clears the Terminal.
options = param.Dict(allow_refs=False, class_=<class ‘dict’>, default={}, label=’Options’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ac66590>): Initial Options for the Terminal Constructor. cf. https://xtermjs.org/docs/api/terminal/interfaces/iterminaloptions/
output = param.String(allow_refs=False, default=’’, label=’Output’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ac67bd0>): System output written to the Terminal
ncols = param.Integer(allow_refs=False, constant=True, default=0, inclusive_bounds=(True, True), label=’Ncols’, nested_refs=False, readonly=True, rx=<param.reactive.reactive_ops object at 0x16ac6e4d0>): The number of columns in the terminal.
nrows = param.Integer(allow_refs=False, constant=True, default=0, inclusive_bounds=(True, True), label=’Nrows’, nested_refs=False, readonly=True, rx=<param.reactive.reactive_ops object at 0x16ac669d0>): The number of rows in the terminal.
write_to_console = param.Boolean(allow_refs=False, default=False, label=’Write to console’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ac65c90>): Whether or not to write to the server console.
_clears = param.Integer(allow_refs=False, default=0, inclusive_bounds=(True, True), label=’ clears’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ac669d0>): Sends a signal to clear the terminal

_output = param.String(allow_refs=False, default=’’, label=’ output’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ac65d90>)

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

property subprocess#: The subprocess enables running commands like ‘ls’, [‘ls’, ‘-l’], ‘bash’, ‘python’ and ‘ipython’ in the terminal.

class panel.widgets.TextAreaInput(**params: Any)[source]#

Bases: _TextInputBase

`.

Parameters inherited from:

auto_grow = param.Boolean(allow_refs=False, default=False, label=’Auto grow’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ac91f10>): Whether the text area should automatically grow vertically to accommodate the current text.
cols = param.Integer(allow_refs=False, default=20, inclusive_bounds=(True, True), label=’Cols’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ac93b50>): Number of columns in the text input field.
max_rows = param.Integer(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’Max rows’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ac94250>): When combined with auto_grow this determines the maximum number of rows the input area can grow.
rows = param.Integer(allow_refs=False, default=2, inclusive_bounds=(True, True), label=’Rows’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ac93a90>): Number of rows in the text input field.
resizable = param.ObjectSelector(allow_refs=False, label=’Resizable’, names={}, nested_refs=False, objects=[‘both’, ‘width’, ‘height’, False], rx=<param.reactive.reactive_ops object at 0x16ac92010>): Whether the layout is interactively resizable, and if so in which dimensions: width, height, or both. Can only be set during initialization.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, onkeyup=False, **params) → Viewable[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.
onkeyup: boolean: Whether to trigger events on every key press.
params: dict: Keyword arguments to be passed to the widget constructor

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.TextEditor(**params: Any)[source]#

Bases: Widget

The TextEditor widget provides a WYSIWYG (what-you-see-is-what-you-get) rich text editor which outputs HTML.

The editor is built on top of the [Quill.js](https://quilljs.com/) library.

Reference: https://panel.holoviz.org/reference/widgets/TextEditor.html

Example:

>>> TextEditor(placeholder='Enter some text')

Parameters inherited from:

value = param.String(allow_refs=False, default=’’, label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16acaadd0>): State of the current text in the editor
disabled = param.Boolean(allow_refs=False, default=False, label=’Disabled’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16acb4950>): Whether the editor is disabled.
mode = param.Selector(allow_refs=False, default=’toolbar’, label=’Mode’, names={}, nested_refs=False, objects=[‘bubble’, ‘toolbar’], rx=<param.reactive.reactive_ops object at 0x16acb5ed0>): Whether to display a toolbar or a bubble menu on highlight.
toolbar = param.ClassSelector(allow_refs=False, class_=(<class ‘list’>, <class ‘bool’>), default=True, label=’Toolbar’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16acb4550>): Toolbar configuration either as a boolean toggle or a configuration specified as a list.
placeholder = param.String(allow_refs=False, default=’’, label=’Placeholder’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16acaa890>): Placeholder output when the editor is empty.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.TextInput(**params: Any)[source]#

Bases: _TextInputBase

The TextInput widget allows entering any string using a text input box.

Reference: https://panel.holoviz.org/reference/widgets/TextInput.html

Example:

>>> TextInput(name='Name', placeholder='Enter your name here ...')

Parameters inherited from:

enter_pressed = param.Event(allow_refs=True, default=False, label=’Enter pressed’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16acd1590>): Event when the enter key has been pressed.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, onkeyup=False, **params) → Viewable[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.
onkeyup: boolean: Whether to trigger events on every key press.
params: dict: Keyword arguments to be passed to the widget constructor

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.TextToSpeech(*, _voices, auto_speak, cancel, pause, resume, speak, lang, pitch, rate, voice, volume, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: Utterance, Widget

The TextToSpeech widget wraps the HTML5 SpeechSynthesis API

See https://developer.mozilla.org/en-US/docs/Web/API/SpeechSynthesis

Reference: https://panel.holoviz.org/reference/widgets/TextToSpeech.html

Example:

>>> TextToSpeech(name="Speech Synthesis", value="Data apps are nice")

Parameters inherited from:

auto_speak = param.Boolean(allow_refs=False, default=True, label=’Auto speak’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ace6e10>): Whether or not to automatically speak when the value changes.
cancel = param.Event(allow_refs=False, default=False, label=’Cancel’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ad14f10>): Removes all utterances from the utterance queue.
pause = param.Event(allow_refs=False, default=False, label=’Pause’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ace6ed0>): Puts the TextToSpeak object into a paused state.
resume = param.Event(allow_refs=False, default=False, label=’Resume’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ad14e50>): Puts the TextToSpeak object into a non-paused state: resumes it if it was already paused.
paused = param.Boolean(allow_refs=False, constant=True, default=False, label=’Paused’, nested_refs=False, readonly=True, rx=<param.reactive.reactive_ops object at 0x16ace6f10>): A Boolean that returns true if the TextToSpeak object is in a paused state.
pending = param.Boolean(allow_refs=False, constant=True, default=False, label=’Pending’, nested_refs=False, readonly=True, rx=<param.reactive.reactive_ops object at 0x16ad14bd0>): A Boolean that returns true if the utterance queue contains as-yet-unspoken utterances.
speak = param.Event(allow_refs=False, default=False, label=’Speak’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ace6ed0>): Speak. I.e. send a new Utterance to the browser
speaking = param.Boolean(allow_refs=False, constant=True, default=False, label=’Speaking’, nested_refs=False, readonly=True, rx=<param.reactive.reactive_ops object at 0x16ad14d50>): A Boolean that returns true if an utterance is currently in the process of being spoken — even if TextToSpeak is in a paused state.
voices = param.List(allow_refs=False, bounds=(0, None), constant=True, default=[], label=’Voices’, nested_refs=False, readonly=True, rx=<param.reactive.reactive_ops object at 0x16ace6ed0>): Returns a list of Voice objects representing all the available voices on the current device.

_voices = param.List(allow_refs=False, bounds=(0, None), default=[], label=’ voices’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ad14e50>)

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

set_voices(voices)[source]#: Updates the lang and voice parameter objects, default and value

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

to_dict(include_uuid=True)[source]#

Returns the object parameter values in a dictionary

Returns:: Dict: [description]

class panel.widgets.TimePicker(**params: Any)[source]#

Bases: _TimeCommon

The TimePicker allows selecting a time value using a text box and a time-picking utility.

Reference: https://panel.holoviz.org/reference/widgets/TimePicker.html

Example:

>>> TimePicker(
...     value="12:59:31", start="09:00:00", end="18:00:00", name="Time"
... )

Parameters inherited from:

value = param.ClassSelector(allow_None=True, allow_refs=False, class_=(<class ‘datetime.time’>, <class ‘str’>), label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ace3190>): The current value
start = param.ClassSelector(allow_None=True, allow_refs=False, class_=(<class ‘datetime.time’>, <class ‘str’>), label=’Start’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ad0cad0>): Inclusive lower bound of the allowed time selection
end = param.ClassSelector(allow_None=True, allow_refs=False, class_=(<class ‘datetime.time’>, <class ‘str’>), label=’End’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ace30d0>): Inclusive upper bound of the allowed time selection
format = param.String(allow_refs=False, default=’H:i’, label=’Format’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ad0c6d0>): Formatting specification for the display of the picked date. +—+————————————+————+ | H | Hours (24 hours) | 00 to 23 | | h | Hours | 1 to 12 | | G | Hours, 2 digits with leading zeros | 1 to 12 | | i | Minutes | 00 to 59 | | S | Seconds, 2 digits | 00 to 59 | | s | Seconds | 0, 1 to 59 | | K | AM/PM | AM or PM | +—+————————————+————+ See also https://flatpickr.js.org/formatting/#date-formatting-tokens.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.Toggle(**params)[source]#

Bases: _ButtonBase, IconMixin

The Toggle widget allows toggling a single condition between True/False states.

This widget is interchangeable with the Checkbox widget.

Reference: https://panel.holoviz.org/reference/widgets/Toggle.html

Example:

>>> Toggle(name='Toggle', button_type='success')

Parameters inherited from:

value = param.Boolean(allow_refs=False, default=False, label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ad3a810>): Whether the button is currently toggled.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.ToggleGroup(*, options, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: SingleSelectBase

This class is a factory of ToggleGroup widgets.

A ToggleGroup is a group of widgets which can be switched ‘on’ or ‘off’.

Two types of widgets are available through the widget_type argument :

‘button’ (default)
‘box’

Two different behaviors are available through behavior argument:

‘check’ (default)boolean
Any number of widgets can be selected. In this case value is a ‘list’ of objects.
‘radio’boolean
One and only one widget is switched on. In this case value is an ‘object’.

Parameters inherited from:

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.ToggleIcon(*, active_icon, icon, size, description, description_delay, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: _ClickableIcon, TooltipMixin

The ToggleIcon widget allows toggling a single condition between True/False states. This widget is interchangeable with the Checkbox and Toggle widget.

This widget incorporates a value attribute, which alternates between False and True.

Reference: https://panel.holoviz.org/reference/widgets/ToggleIcon.html

Example:

>>> pn.widgets.ToggleIcon(
...     icon="thumb-up", active_icon="thumb-down", size="4em", description="Like"
... )

Parameters inherited from:

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.TooltipIcon(**params: Any)[source]#

Bases: Widget

The TooltipIcon displays a small ? icon. When you hover over the ? icon, the value will display.

Use the TooltipIcon to provide

helpful information to users without taking up a lot of screen space
tooltips next to Panel widgets that do not support tooltips yet.

Reference: https://panel.holoviz.org/reference/indicators/TooltipIcon.html

Example:

>>> pn.widgets.TooltipIcon(value="This is a simple tooltip by using a string")

Parameters inherited from:

value = param.ClassSelector(allow_refs=False, class_=(<class ‘str’>, <class ‘bokeh.models.ui.tooltips.Tooltip’>), default=’Description’, label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ad8f4d0>): The description in the tooltip.
align = param.Align(allow_refs=False, default=’center’, label=’Align’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ad88bd0>): Whether the object should be aligned with the start, end or center of its container. If set as a tuple it will declare (vertical, horizontal) alignment.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.Tqdm(*, layout, lock, max, progress, text, text_pane, write_to_console, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: Indicator

The Tqdm indicator wraps the well known tqdm progress indicator and displays the progress towards some target in your Panel app.

Reference: https://panel.holoviz.org/reference/indicators/Tqdm.html

Example:

>>> tqdm = Tqdm()
>>> for i in tqdm(range(0,10), desc="My loop", leave=True, colour='#666666'):
...     time.sleep(timeout)

Parameters inherited from:

value = param.Integer(allow_refs=False, bounds=(-1, None), default=0, inclusive_bounds=(True, True), label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16adaf5d0>): The current value of the progress bar. If set to -1 the progress bar will be indeterminate and animate depending on the active parameter.
margin = param.Parameter(allow_refs=False, default=0, label=’Margin’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16adb0e50>): Allows to create additional space around the component. May be specified as a two-tuple of the form (vertical, horizontal) or a four-tuple (top, right, bottom, left).
width = param.Integer(allow_refs=False, bounds=(0, None), default=400, inclusive_bounds=(True, True), label=’Width’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16adaf510>): The width of the component (in pixels). This can be either fixed or preferred width, depending on width sizing policy.
layout = param.ClassSelector(allow_None=True, allow_refs=False, class_=(<class ‘panel.layout.base.Column’>, <class ‘panel.layout.base.Row’>), constant=True, label=’Layout’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16adb1010>): The layout for the text and progress indicator.
lock = param.ClassSelector(allow_None=True, allow_refs=False, class_=<class ‘object’>, label=’Lock’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16adaee10>): The multithreading.Lock or multiprocessing.Lock object to be used by Tqdm.
max = param.Integer(allow_refs=False, default=100, inclusive_bounds=(True, True), label=’Max’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16adb0e50>): The maximum value of the progress bar.
progress = param.ClassSelector(allow_None=True, allow_refs=False, class_=<class ‘panel.widgets.indicators.Progress’>, label=’Progress’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16adaf110>): The Progress indicator used to display the progress.
text = param.String(allow_refs=False, default=’’, label=’Text’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16adb05d0>): The current tqdm style progress text.
text_pane = param.ClassSelector(allow_None=True, allow_refs=False, class_=<class ‘panel.pane.markup.Str’>, label=’Text pane’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16adaf110>): The pane to display the text to.
write_to_console = param.Boolean(allow_refs=False, default=False, label=’Write to console’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16adb0490>): Whether or not to also write to the console.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

reset()[source]#: Resets the parameters

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.Trend(*, data, layout, neg_color, plot_color, plot_type, plot_x, plot_y, pos_color, value_change, selection, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: SyncableData, Indicator

The Trend indicator enables the user to display a dashboard kpi card.

The card can be layout out as:

a column (text and plot on top of each other) or a row (text and
plot after each other)

Reference: https://panel.holoviz.org/reference/indicators/Trend.html

Example:

>>> data = {'x': np.arange(50), 'y': np.random.randn(50).cumsum()}
>>> Trend(name='Price', data=data, plot_type='area', width=200, height=200)

Parameters inherited from:

value = param.Parameter(allow_refs=False, default=’auto’, label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16adec710>): The primary value to be displayed.
sizing_mode = param.ObjectSelector(allow_refs=False, label=’Sizing mode’, names={}, nested_refs=False, objects=[‘fixed’, ‘stretch_width’, ‘stretch_height’, ‘stretch_both’, ‘scale_width’, ‘scale_height’, ‘scale_both’, None], rx=<param.reactive.reactive_ops object at 0x16adee190>): How the component should size itself. This is a high-level setting for maintaining width and height of the component. To gain more fine grained control over sizing, use width_policy, height_policy and aspect_ratio instead (those take precedence over sizing_mode). "fixed" Component is not responsive. It will retain its original width and height regardless of any subsequent browser window resize events. "stretch_width" Component will responsively resize to stretch to the available width, without maintaining any aspect ratio. The height of the component depends on the type of the component and may be fixed or fit to component’s contents. "stretch_height" Component will responsively resize to stretch to the available height, without maintaining any aspect ratio. The width of the component depends on the type of the component and may be fixed or fit to component’s contents. "stretch_both" Component is completely responsive, independently in width and height, and will occupy all the available horizontal and vertical space, even if this changes the aspect ratio of the component. "scale_width" Component will responsively resize to stretch to the available width, while maintaining the original or provided aspect ratio. "scale_height" Component will responsively resize to stretch to the available height, while maintaining the original or provided aspect ratio. "scale_both" Component will responsively resize to both the available width and height, while maintaining the original or provided aspect ratio.
data = param.Parameter(allow_None=True, allow_refs=False, label=’Data’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16adec650>): The plot data declared as a dictionary of arrays or a DataFrame.

layout = param.ObjectSelector(allow_refs=False, default=’column’, label=’Layout’, names={}, nested_refs=False, objects=[‘column’, ‘row’], rx=<param.reactive.reactive_ops object at 0x16adee050>)

plot_x = param.String(allow_refs=False, default=’x’, label=’Plot x’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16adec790>): The name of the key in the plot_data to use on the x-axis.
plot_y = param.String(allow_refs=False, default=’y’, label=’Plot y’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16adedd10>): The name of the key in the plot_data to use on the y-axis.
plot_color = param.String(allow_refs=False, default=’#428bca’, label=’Plot color’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16adee390>): The color to use in the plot.
plot_type = param.ObjectSelector(allow_refs=False, default=’bar’, label=’Plot type’, names={}, nested_refs=False, objects=[‘line’, ‘step’, ‘area’, ‘bar’], rx=<param.reactive.reactive_ops object at 0x16adee290>): The plot type to render the plot data as.
pos_color = param.String(allow_refs=False, default=’#5cb85c’, label=’Pos color’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16adee050>): The color used to indicate a positive change.
neg_color = param.String(allow_refs=False, default=’#d9534f’, label=’Neg color’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16adee210>): The color used to indicate a negative change.
value_change = param.Parameter(allow_refs=False, default=’auto’, label=’Value change’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16adec650>): A secondary value. For example the change in percent.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

patch(patch_value: 'pd.DataFrame' | 'pd.Series' | dict) → None[source]#

Efficiently patches (updates) the existing value with the patch_value.

Arguments#

patch_value: (pd.DataFrame | pd.Series | Dict): The value(s) to patch the existing value with.

Raises#

ValueError: Raised if the patch_value is not a supported type.

Examples#

Patch a DataFrame with a Dictionary row. >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> obj = DataComponent(value) >>> patch_value = {“x”: [(0, 3)]} >>> obj.patch(patch_value) >>> obj.value.to_dict(“list”) {‘x’: [3, 2], ‘y’: [‘a’, ‘b’]}

Patch a Dataframe with a Dictionary of Columns. >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> obj = DataComponent(value) >>> patch_value = {“x”: [(slice(2), (3,4))], “y”: [(1,’d’)]} >>> obj.patch(patch_value) >>> obj.value.to_dict(“list”) {‘x’: [3, 4], ‘y’: [‘a’, ‘d’]}

Patch a DataFrame with a Series. Please note the index is used in the update. >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> obj = DataComponent(value) >>> patch_value = pd.Series({“index”: 1, “x”: 4, “y”: “d”}) >>> obj.patch(patch_value) >>> obj.value.to_dict(“list”) {‘x’: [1, 4], ‘y’: [‘a’, ‘d’]}

Patch a Dataframe with a Dataframe. Please note the index is used in the update. >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> obj = DataComponent(value) >>> patch_value = pd.DataFrame({“x”: [3, 4], “y”: [“c”, “d”]}) >>> obj.patch(patch_value) >>> obj.value.to_dict(“list”) {‘x’: [3, 4], ‘y’: [‘c’, ‘d’]}

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

sizing_mode = None#

stream(stream_value: 'pd.DataFrame' | 'pd.Series' | dict, rollover: int | None = None, reset_index: bool = True) → None[source]#

Streams (appends) the stream_value provided to the existing value in an efficient manner.

Arguments#

stream_value: (pd.DataFrame | pd.Series | Dict): The new value(s) to append to the existing value.
rollover: (int | None, default=None): A maximum column size, above which data from the start of the column begins to be discarded. If None, then columns will continue to grow unbounded.
reset_index (bool, default=True):: If True and the stream_value is a DataFrame, then its index is reset. Helps to keep the index unique and named index.

Raises#

ValueError: Raised if the stream_value is not a supported type.

Examples#

Stream a Series to a DataFrame >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> obj = DataComponent(value) >>> stream_value = pd.Series({“x”: 4, “y”: “d”}) >>> obj.stream(stream_value) >>> obj.value.to_dict(“list”) {‘x’: [1, 2, 4], ‘y’: [‘a’, ‘b’, ‘d’]}

Stream a Dataframe to a Dataframe >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> obj = DataComponent(value) >>> stream_value = pd.DataFrame({“x”: [3, 4], “y”: [“c”, “d”]}) >>> obj.stream(stream_value) >>> obj.value.to_dict(“list”) {‘x’: [1, 2, 3, 4], ‘y’: [‘a’, ‘b’, ‘c’, ‘d’]}

Stream a Dictionary row to a DataFrame >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> tabulator = DataComponent(value) >>> stream_value = {“x”: 4, “y”: “d”} >>> obj.stream(stream_value) >>> obj.value.to_dict(“list”) {‘x’: [1, 2, 4], ‘y’: [‘a’, ‘b’, ‘d’]}

Stream a Dictionary of Columns to a Dataframe >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> obj = DataComponent(value) >>> stream_value = {“x”: [3, 4], “y”: [“c”, “d”]} >>> obj.stream(stream_value) >>> obj.value.to_dict(“list”) {‘x’: [1, 2, 3, 4], ‘y’: [‘a’, ‘b’, ‘c’, ‘d’]}

class panel.widgets.Utterance(*, lang, pitch, rate, value, voice, volume, name)[source]#

Bases: Parameterized

An utterance is the smallest unit of speech in spoken language analysis.

The Utterance Model wraps the HTML5 SpeechSynthesisUtterance API

See https://developer.mozilla.org/en-US/docs/Web/API/SpeechSynthesisUtterance

value = param.String(allow_refs=False, default=’’, label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ae14f90>): The text that will be synthesised when the utterance is spoken. The text may be provided as plain text, or a well-formed SSML document.
lang = param.ObjectSelector(allow_refs=False, default=’’, label=’Lang’, names={}, nested_refs=False, objects=[‘’], rx=<param.reactive.reactive_ops object at 0x16ae21610>): The language of the utterance.
pitch = param.Number(allow_refs=False, bounds=(0.0, 2.0), default=1.0, inclusive_bounds=(True, True), label=’Pitch’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ae20e10>): The pitch at which the utterance will be spoken at expressed as a number between 0 and 2.
rate = param.Number(allow_refs=False, bounds=(0.1, 10.0), default=1.0, inclusive_bounds=(True, True), label=’Rate’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ae204d0>): The speed at which the utterance will be spoken at expressed as a number between 0.1 and 10.
voice = param.ObjectSelector(allow_refs=False, label=’Voice’, names={}, nested_refs=False, objects=[], rx=<param.reactive.reactive_ops object at 0x16ae15650>): The voice that will be used to speak the utterance.
volume = param.Number(allow_refs=False, bounds=(0.0, 1.0), default=1.0, inclusive_bounds=(True, True), label=’Volume’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ae20210>): The volume that the utterance will be spoken at expressed as a number between 0 and 1.

set_voices(voices)[source]#: Updates the lang and voice parameter objects, default and value

to_dict(include_uuid=True)[source]#

Returns the object parameter values in a dictionary

Returns:: Dict: [description]

class panel.widgets.VideoStream(**params: Any)[source]#

Bases: Widget

The VideoStream displays a video from a local stream (for example from a webcam) and allows accessing the streamed video data from Python.

Reference: https://panel.holoviz.org/reference/widgets/VideoStream.html

Example:

>>> VideoStream(name='Video Stream', timeout=100)

Parameters inherited from:

value = param.String(allow_refs=False, default=’’, label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ae23990>): A base64 representation of the video stream snapshot.
format = param.ObjectSelector(allow_refs=False, default=’png’, label=’Format’, names={}, nested_refs=False, objects=[‘png’, ‘jpeg’], rx=<param.reactive.reactive_ops object at 0x16ae24550>): The file format as which the video is returned.
paused = param.Boolean(allow_refs=False, default=False, label=’Paused’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ae23950>): Whether the video is currently paused
timeout = param.Number(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’Timeout’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ae24710>): Interval between snapshots in millisecons

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

snapshot()[source]#: Triggers a snapshot of the current VideoStream state to sync the widget value.

class panel.widgets.Voice(*, default, lang, local_service, voice_uri, name)[source]#

Bases: Parameterized

The current device (i.e. OS and Browser) provides a list of Voices. Each with a unique name and speaking a specific language.

Wraps the HTML5 SpeecSynthesisVoice API

See https://developer.mozilla.org/en-US/docs/Web/API/SpeechSynthesisVoice

default = param.Boolean(allow_refs=False, constant=True, default=False, label=’Default’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ae36d90>): A Boolean indicating whether the voice is the default voice for the current app language (True), or not (False.)
lang = param.String(allow_refs=False, constant=True, default=’’, label=’Lang’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ae30590>): Returns a BCP 47 language tag indicating the language of the voice.
local_service = param.Boolean(allow_refs=False, constant=True, default=False, label=’Local service’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ae36cd0>): A Boolean indicating whether the voice is supplied by a local speech synthesizer service (True), or a remote speech synthesizer service (False.)
voice_uri = param.String(allow_refs=False, constant=True, default=’’, label=’Voice uri’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ae30210>): Returns the type of URI and location of the speech synthesis service for this voice.

static group_by_lang(voices)[source]#: Returns a dictionary where the key is the lang and the value is a list of voices for that language.

static to_voices_list(voices)[source]#: Returns a list of Voice objects from the list of dicts provided

class panel.widgets.Widget(**params: Any)[source]#

Bases: Reactive, WidgetBase

Widgets allow syncing changes in bokeh widget models with the parameters on the Widget instance.

Parameters inherited from:

height = param.Integer(allow_None=True, allow_refs=True, bounds=(0, None), inclusive_bounds=(True, True), label=’Height’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ae32410>): The height of the component (in pixels). This can be either fixed or preferred height, depending on height sizing policy.
margin = param.Margin(allow_None=True, allow_refs=True, default=(5, 10), label=’Margin’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ae327d0>): Allows to create additional space around the component. May be specified as a two-tuple of the form (vertical, horizontal) or a four-tuple (top, right, bottom, left).
width = param.Integer(allow_None=True, allow_refs=True, bounds=(0, None), inclusive_bounds=(True, True), label=’Width’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ae323d0>): The width of the component (in pixels). This can be either fixed or preferred width, depending on width sizing policy.
disabled = param.Boolean(allow_refs=True, default=False, label=’Disabled’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x16ae318d0>): Whether the widget is disabled.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

`_mixin` Module#

class panel.widgets._mixin.TooltipMixin(**params: Any)[source]#

Bases: Widget

Parameters inherited from:

description = param.ClassSelector(allow_None=True, allow_refs=True, class_=(<class ‘str’>, <class ‘bokeh.models.ui.tooltips.Tooltip’>, <class ‘panel.widgets.indicators.TooltipIcon’>), label=’Description’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1737551d0>): The description in the tooltip.
description_delay = param.Integer(allow_refs=True, default=500, inclusive_bounds=(True, True), label=’Description delay’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x173752e50>): Delay (in milliseconds) to display the tooltip after the cursor has hovered over the Button, default is 500ms.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

`base` Module#

Defines the Widget base class which provides bi-directional communication between the rendered dashboard and the Widget parameters.

class panel.widgets.base.CompositeWidget(*, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: Widget

A baseclass for widgets which are made up of two or more other widgets

Parameters inherited from:

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.base.Widget(**params: Any)[source]#

Bases: Reactive, WidgetBase

Widgets allow syncing changes in bokeh widget models with the parameters on the Widget instance.

Parameters inherited from:

height = param.Integer(allow_None=True, allow_refs=True, bounds=(0, None), inclusive_bounds=(True, True), label=’Height’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17393a3d0>): The height of the component (in pixels). This can be either fixed or preferred height, depending on height sizing policy.
margin = param.Margin(allow_None=True, allow_refs=True, default=(5, 10), label=’Margin’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x173938050>): Allows to create additional space around the component. May be specified as a two-tuple of the form (vertical, horizontal) or a four-tuple (top, right, bottom, left).
width = param.Integer(allow_None=True, allow_refs=True, bounds=(0, None), inclusive_bounds=(True, True), label=’Width’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x173939d10>): The width of the component (in pixels). This can be either fixed or preferred width, depending on width sizing policy.
disabled = param.Boolean(allow_refs=True, default=False, label=’Disabled’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x171421d50>): Whether the widget is disabled.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.base.WidgetBase(*, value, name)[source]#

Bases: Parameterized

WidgetBase provides an abstract baseclass for widget components which can be used to implement a custom widget-like type without implementing the methods associated with a Reactive Panel component, e.g. it may be used as a mix-in to a PyComponent or JSComponent.

value = param.Parameter(allow_None=True, allow_refs=False, label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1738b42d0>): The widget value which the widget type resolves to when used as a reactive param reference.

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

`button` Module#

Defines the Button and button-like widgets which allow triggering events or merely toggling between on-off states.

class panel.widgets.button.Button(*, clicks, button_style, button_type, icon, icon_size, description, description_delay, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: _ButtonBase, _ClickButton, IconMixin, TooltipMixin

The Button widget allows triggering events when the button is clicked.

The Button provides a value parameter, which will toggle from False to True while the click event is being processed

It also provides an additional clicks parameter, that can be watched to subscribe to click events.

Reference: https://panel.holoviz.org/reference/widgets/Button.html#widgets-gallery-button

Example:

>>> pn.widgets.Button(name='Click me', icon='caret-right', button_type='primary')

Parameters inherited from:

value = param.Event(allow_refs=True, default=False, label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x172f735d0>): Toggles from False to True while the event is being processed.
clicks = param.Integer(allow_refs=True, default=0, inclusive_bounds=(True, True), label=’Clicks’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x173c66410>): Number of clicks (can be listened to)

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

js_on_click(args: dict[str, Any] = {}, code: str = '') → Callback[source]#

Allows defining a JS callback to be triggered when the button is clicked.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
code: str: The Javascript code to execute when the button is clicked.

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a Javascript (JS) callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
**callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] | None = None, args: dict[str, Any] | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Button to those on the target object in Javascript (JS) code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value(s) to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally. Default is False.
**links: dict[str,str]: A mapping between properties on the source model and the target model property to link it to.

Returns#

Link: The Link can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

on_click(callback: Callable[[Event], None | Awaitable[None]]) → Watcher[source]#

Register a callback to be executed when the Button is clicked.

The callback is given an Event argument declaring the number of clicks

Example#

>>> button = pn.widgets.Button(name='Click me')
>>> def handle_click(event):
...    print("I was clicked!")
>>> button.on_click(handle_click)

Arguments#

callback:: The function to run on click events. Must accept a positional Event argument. Can be a sync or async function

Returns#

watcher: param.Parameterized.Watcher: A Watcher that executes the callback when the button is clicked.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.button.IconMixin(**params)[source]#

Bases: Widget

Parameters inherited from:

icon = param.String(allow_None=True, allow_refs=True, label=’Icon’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x173ca2410>): An icon to render to the left of the button label. Either an SVG or an icon name which is loaded from https://tabler-icons.io.
icon_size = param.String(allow_refs=True, default=’1em’, label=’Icon size’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x173ca3c10>): Size of the icon as a string, e.g. 12px or 1em.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.button.MenuButton(*, clicked, items, split, button_style, button_type, icon, icon_size, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: _ButtonBase, _ClickButton, IconMixin

The MenuButton widget allows specifying a list of menu items to select from triggering events when the button is clicked.

Unlike other widgets, it does not have a value parameter. Instead it has a clicked parameter that can be watched to trigger events and which reports the last clicked menu item.

Reference: https://panel.holoviz.org/reference/widgets/MenuButton.html

Example:

>>> menu_items = [('Option A', 'a'), ('Option B', 'b'), None, ('Option C', 'c')]
>>> MenuButton(name='Dropdown', items=menu_items, button_type='primary')

Parameters inherited from:

clicked = param.String(allow_None=True, allow_refs=False, label=’Clicked’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x173cbe110>): Last menu item that was clicked.
items = param.List(allow_refs=False, bounds=(0, None), default=[], label=’Items’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x173cb8e90>): Menu items in the dropdown. Allows strings, tuples of the form (title, value) or Nones to separate groups of items.
split = param.Boolean(allow_refs=False, default=False, label=’Split’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x173cbc310>): Whether to add separate dropdown area to button.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

js_on_click(args: dict[str, Any] = {}, code: str = '') → Callback[source]#

Allows defining a JS callback to be triggered when the button is clicked.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
code: str: The Javascript code to execute when the button is clicked.

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a Javascript (JS) callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
**callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

on_click(callback: Callable[[Event], None]) → Watcher[source]#

Register a callback to be executed when the button is clicked.

The callback is given an Event argument declaring the number of clicks

Arguments#

callback: (Callable[[param.parameterized.Event], None]): The function to run on click events. Must accept a positional Event argument

Returns#

watcher: param.Parameterized.Watcher: A Watcher that executes the callback when the MenuButton is clicked.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.button.Toggle(**params)[source]#

Bases: _ButtonBase, IconMixin

The Toggle widget allows toggling a single condition between True/False states.

This widget is interchangeable with the Checkbox widget.

Reference: https://panel.holoviz.org/reference/widgets/Toggle.html

Example:

>>> Toggle(name='Toggle', button_type='success')

Parameters inherited from:

value = param.Boolean(allow_refs=False, default=False, label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x173cc4790>): Whether the button is currently toggled.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

`codeeditor` Module#

Defines the CodeEditor widget based on Ace.

class panel.widgets.codeeditor.CodeEditor(*, annotations, filename, language, on_keyup, print_margin, readonly, theme, value_input, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: Widget

The CodeEditor widget allows displaying and editing code in the powerful Ace editor.

Reference: https://panel.holoviz.org/reference/widgets/CodeEditor.html

Example:

>>> CodeEditor(value=py_code, language='python', theme='monokai')

Parameters inherited from:

value = param.String(allow_refs=False, default=’’, label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17439e910>): State of the current code in the editor if on_keyup. Otherwise, only upon loss of focus, i.e. clicking outside the editor, or pressing <Ctrl+Enter> or <Cmd+Enter>.
annotations = param.List(allow_refs=False, bounds=(0, None), default=[], label=’Annotations’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174397a90>): List of annotations to add to the editor.
filename = param.String(allow_refs=False, default=’’, label=’Filename’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17439e8d0>): Filename from which to deduce language
language = param.String(allow_refs=False, default=’text’, label=’Language’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17439e910>): Language of the editor
on_keyup = param.Boolean(allow_refs=False, default=True, label=’On keyup’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17439f0d0>): Whether to update the value on every key press or only upon loss of focus / hotkeys.
print_margin = param.Boolean(allow_refs=False, default=False, label=’Print margin’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17439c090>): Whether to show the a print margin.
readonly = param.Boolean(allow_refs=False, default=False, label=’Readonly’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17439e8d0>): Define if editor content can be modified. Alias for disabled.
theme = param.ObjectSelector(allow_refs=False, default=’chrome’, label=’Theme’, names={}, nested_refs=False, objects=[‘ambiance’, ‘chaos’, ‘chrome’, ‘clouds’, ‘clouds_midnight’, ‘cobalt’, ‘crimson_editor’, ‘dawn’, ‘dracula’, ‘dreamweaver’, ‘eclipse’, ‘github’, ‘gob’, ‘gruvbox’, ‘idle_fingers’, ‘iplastic’, ‘katzenmilch’, ‘kr_theme’, ‘kuroir’, ‘merbivore’, ‘merbivore_soft’, ‘mono_industrial’, ‘monokai’, ‘pastel_on_dark’, ‘solarized_dark’, ‘solarized_light’, ‘sqlserver’, ‘terminal’, ‘textmate’, ‘tomorrow’, ‘tomorrow_night’, ‘tomorrow_night_blue’, ‘tomorrow_night_bright’, ‘tomorrow_night_eighties’, ‘twilight’, ‘vibrant_ink’, ‘xcode’], rx=<param.reactive.reactive_ops object at 0x17439e810>): Theme of the editor
value_input = param.String(allow_refs=False, default=’’, label=’Value input’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17439e8d0>): State of the current code updated on every key press. Identical to value if on_keyup.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

`debugger` Module#

The Debugger Widget is an uneditable Card that gives you feedback on errors thrown by your Panel callbacks.

class panel.widgets.debugger.CheckFilter(name='')[source]#

Bases: Filter

add_debugger(debugger)[source]#

Add a debugger to this logging filter.

Parameters#

widgpanel.widgets.Debugger: The widget displaying the logs.

Returns#

None.

filter(record)[source]#: Will filter out messages coming from a different bokeh document than the document where the debugger is embedded in server mode. Returns True if no debugger was added.

class panel.widgets.debugger.Debugger(*, _number_of_errors, _number_of_infos, _number_of_warnings, formatter_args, level, logger_names, only_last, active_header_background, button_css_classes, collapsed, collapsible, header, header_background, header_color, header_css_classes, hide_header, title, title_css_classes, auto_scroll_limit, scroll_button_threshold, scroll_position, view_latest, scroll, objects, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, name)[source]#

Bases: Card

A uneditable Card layout holding a terminal printing out logs from your callbacks. By default, it will only print exceptions. If you want to add your own log, use the panel.callbacks logger within your callbacks: logger = logging.getLogger(‘panel.callbacks’)

Parameters inherited from:

_number_of_errors = param.Integer(allow_refs=False, bounds=(0, None), default=0, inclusive_bounds=(True, True), label=’ number of errors’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174568e10>): Number of logged errors since last acknowledged.
_number_of_warnings = param.Integer(allow_refs=False, bounds=(0, None), default=0, inclusive_bounds=(True, True), label=’ number of warnings’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174579310>): Number of logged warnings since last acknowledged.
_number_of_infos = param.Integer(allow_refs=False, bounds=(0, None), default=0, inclusive_bounds=(True, True), label=’ number of infos’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174568e10>): Number of logged information since last acknowledged.
only_last = param.Boolean(allow_refs=False, default=True, label=’Only last’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17456a7d0>): Whether only the last stack is printed or the full.
level = param.Integer(allow_refs=False, default=40, inclusive_bounds=(True, True), label=’Level’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174568e10>): Logging level to print in the debugger terminal.
formatter_args = param.Dict(allow_refs=False, class_=<class ‘dict’>, default={‘fmt’: ‘%(asctime)s [%(name)s - %(levelname)s]: %(message)s’}, label=’Formatter args’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174263850>): Arguments to pass to the logging formatter. See the standard python logging libraries.
logger_names = param.List(allow_refs=False, bounds=(1, None), class_=<class ‘str’>, default=[‘panel’], item_type=<class ‘str’>, label=’Logger names’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17456f550>): Loggers which will be prompted in the debugger terminal.

append(obj: Any) → None[source]#: Appends an object to the layout.

Arguments#

obj (object): Panel component to add to the layout.

clear() → list[Viewable][source]#: Clears the objects on this layout.

Returns#

objects (list[Viewable]): List of cleared objects.

clone(*objects: Any, **params: Any) → ListLike[source]#: Makes a copy of the layout sharing the same parameters.

Arguments#

objects: Objects to add to the cloned layout. params: Keyword arguments override the parameters on the clone.

Returns#

Cloned layout object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

extend(objects: Iterable[Any]) → None[source]#: Extends the objects on this layout with a list.

Arguments#

objects (list): List of panel components to add to the layout.

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

index(object) → int[source]#: Returns the integer index of the supplied object in the list of objects.

Arguments#

obj (object): Panel component to look up the index for.

Returns#

index (int): Integer index of the object in the layout.

insert(index: int, obj: Any) → None[source]#: Inserts an object in the layout at the specified index.

Arguments#

index (int): Index at which to insert the object. object (object): Panel components to insert in the layout.

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

pop(index: int) → Viewable[source]#: Pops an item from the layout by index.

Arguments#

index (int): The index of the item to pop from the layout.

remove(obj: Viewable) → None[source]#: Removes an object from the layout.

Arguments#

obj (object): The object to remove from the layout.

reverse() → None[source]#: Reverses the objects in the layout.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.debugger.DebuggerButtons(*, clears, debug_name, terminal_output, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, name)[source]#

Bases: ReactiveHTML

Parameters inherited from:

terminal_output = param.String(allow_refs=False, default=’’, label=’Terminal output’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1745aff10>)

debug_name = param.String(allow_refs=False, default=’’, label=’Debug name’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1745a9790>)

clears = param.Integer(allow_refs=False, default=0, inclusive_bounds=(True, True), label=’Clears’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1745a9c10>)

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

on_event(node: str, event: str, callback: Callable) → None[source]#

Registers a callback to be executed when the specified DOM event is triggered on the named node. Note that the named node must be declared in the HTML. To create a named node you must give it an id of the form id=”name”, where name will be the node identifier.

Arguments#

node: str: Named node in the HTML identifiable via id of the form id=”name”.
event: str: Name of the DOM event to add an event listener to.
callback: callable: A callable which will be given the DOMEvent object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.debugger.TermFormatter(*args, only_last=True, **kwargs)[source]#

Bases: Formatter

converter()#

localtime([seconds]) -> (tm_year,tm_mon,tm_mday,tm_hour,tm_min,: tm_sec,tm_wday,tm_yday,tm_isdst)

Convert seconds since the Epoch to a time tuple expressing local time. When ‘seconds’ is not passed in, convert the current time instead.

format(record)[source]#

Format the specified record as text.

The record’s attribute dictionary is used as the operand to a string formatting operation which yields the returned string. Before formatting the dictionary, a couple of preparatory steps are carried out. The message attribute of the record is computed using LogRecord.getMessage(). If the formatting string uses the time (as determined by a call to usesTime(), formatTime() is called to format the event time. If there is exception information, it is formatted using formatException() and appended to the message.

formatException(ei)[source]#

Format and return the specified exception information as a string.

This default implementation just uses traceback.print_exception()

formatStack(stack_info)[source]#

This method is provided as an extension point for specialized formatting of stack information.

The input data is a string as returned from a call to traceback.print_stack(), but with the last trailing newline removed.

The base implementation just returns the value passed in.

formatTime(record, datefmt=None)[source]#

Return the creation time of the specified LogRecord as formatted text.

This method should be called from format() by a formatter which wants to make use of a formatted time. This method can be overridden in formatters to provide for any specific requirement, but the basic behaviour is as follows: if datefmt (a string) is specified, it is used with time.strftime() to format the creation time of the record. Otherwise, an ISO8601-like (or RFC 3339-like) format is used. The resulting string is returned. This function uses a user-configurable function to convert the creation time to a tuple. By default, time.localtime() is used; to change this for a particular formatter instance, set the ‘converter’ attribute to a function with the same signature as time.localtime() or time.gmtime(). To change it for all formatters, for example if you want all logging times to be shown in GMT, set the ‘converter’ attribute in the Formatter class.

usesTime()[source]#: Check if the format uses the creation time of the record.

`file_selector` Module#

Defines a FileSelector widget which allows selecting files and directories on the server.

class panel.widgets.file_selector.FileSelector(directory: AnyStr | PathLike | None = None, **params)[source]#

Bases: CompositeWidget

The FileSelector widget allows browsing the filesystem on the server and selecting one or more files in a directory.

Reference: https://panel.holoviz.org/reference/widgets/FileSelector.html

Example:

>>> FileSelector(directory='~', file_pattern='*.png')

Parameters inherited from:

value = param.List(allow_refs=False, bounds=(0, None), default=[], label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1748cbd90>): List of selected files.
directory = param.String(allow_refs=False, default=’/Users/runner/work/panel/panel/doc’, label=’Directory’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1749850d0>): The directory to explore.
file_pattern = param.String(allow_refs=False, default=’*’, label=’File pattern’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1748c9d10>): A glob-like pattern to filter the files.
only_files = param.Boolean(allow_refs=False, default=False, label=’Only files’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1748cb610>): Whether to only allow selecting files.
show_hidden = param.Boolean(allow_refs=False, default=False, label=’Show hidden’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1748c9050>): Whether to show hidden files and directories (starting with a period).
size = param.Integer(allow_refs=False, default=10, inclusive_bounds=(True, True), label=’Size’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1749851d0>): The number of options shown at once (note this is the only way to control the height of this widget)
refresh_period = param.Integer(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’Refresh period’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174985a10>): If set to non-None value indicates how frequently to refresh the directory contents in milliseconds.
root_directory = param.String(allow_None=True, allow_refs=False, label=’Root directory’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1748cb290>): If set, overrides directory parameter as the root directory beyond which users cannot navigate.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

`icon` Module#

class panel.widgets.icon.ButtonIcon(*, clicks, toggle_duration, active_icon, icon, size, description, description_delay, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: _ClickableIcon, _ClickButton, TooltipMixin

The ButtonIcon widget facilitates event triggering upon button clicks.

This widget displays a default icon initially. Upon being clicked, an active_icon appears for a specified toggle_duration.

For instance, the ButtonIcon can be effectively utilized to implement a feature akin to ChatGPT’s copy-to-clipboard button.

The button incorporates a value attribute, which alternates between False and True as the click event is processed.

Furthermore, it includes an clicks attribute, enabling subscription to click events for further actions or monitoring.

Reference: https://panel.holoviz.org/reference/widgets/ButtonIcon.html

Example:

>>> button_icon = pn.widgets.ButtonIcon(
...     icon='clipboard',
...     active_icon='check',
...     description='Copy',
...     toggle_duration=2000
... )

Parameters inherited from:

value = param.Boolean(allow_refs=False, default=False, label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174b345d0>): Toggles from False to True while the event is being processed.
clicks = param.Integer(allow_refs=False, default=0, inclusive_bounds=(True, True), label=’Clicks’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174b46a10>): The number of times the button has been clicked.
toggle_duration = param.Integer(allow_refs=False, default=75, inclusive_bounds=(True, True), label=’Toggle duration’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174b46450>): The number of milliseconds the active_icon should be shown for and how long the button should be disabled for.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

js_on_click(args: dict[str, Any] = {}, code: str = '') → Callback[source]#

Allows defining a JS callback to be triggered when the button is clicked.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
code: str: The Javascript code to execute when the button is clicked.

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a Javascript (JS) callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
**callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

on_click(callback: Callable[[Event], None]) → Watcher[source]#

Register a callback to be executed when the button is clicked.

The callback is given an Event argument declaring the number of clicks.

Arguments#

callback: (Callable[[param.parameterized.Event], None]): The function to run on click events. Must accept a positional Event argument

Returns#

watcher: param.Parameterized.Watcher: A Watcher that executes the callback when the MenuButton is clicked.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.icon.ToggleIcon(*, active_icon, icon, size, description, description_delay, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: _ClickableIcon, TooltipMixin

The ToggleIcon widget allows toggling a single condition between True/False states. This widget is interchangeable with the Checkbox and Toggle widget.

This widget incorporates a value attribute, which alternates between False and True.

Reference: https://panel.holoviz.org/reference/widgets/ToggleIcon.html

Example:

>>> pn.widgets.ToggleIcon(
...     icon="thumb-up", active_icon="thumb-down", size="4em", description="Like"
... )

Parameters inherited from:

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

`indicators` Module#

Indicators#

Indicators can be used to indicate status or progress

Check out the Panel gallery of indicators https://panel.holoviz.org/reference/index.html#indicators for inspiration.

How to use indicators#

>>> pn.indicators.Number(
...    name='Rate', value=72, format='{value}%',
...    colors=[(80, 'green'), (100, 'red')]
... )

class panel.widgets.indicators.BooleanIndicator(*, throttle, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: Indicator

BooleanIndicator is an abstract baseclass for indicators that visually indicate a boolean value.

Parameters inherited from:

value = param.Boolean(allow_refs=False, default=False, label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174eb2f50>): Whether the indicator is active or not.
throttle = param.Integer(allow_refs=True, default=500, inclusive_bounds=(True, True), label=’Throttle’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174edab50>): ” Throttles value change events, ensuring that they only toggle off after a minimum time specified in milliseconds has passed.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.indicators.BooleanStatus(*, color, throttle, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: BooleanIndicator

The BooleanStatus is a boolean indicator providing a visual representation of a boolean status as filled or non-filled circle.

If the value is set to True the indicator will be filled while setting it to False will cause it to be non-filled.

Reference: https://panel.holoviz.org/reference/indicators/BooleanStatus.html

Example:

>>> BooleanStatus(value=True, color='primary', width=100, height=100)

Parameters inherited from:

value = param.Boolean(allow_refs=True, default=False, label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174f08e50>): Whether the indicator is active or not.
height = param.Integer(allow_refs=True, bounds=(0, None), default=20, inclusive_bounds=(True, True), label=’Height’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174f0aa90>): height of the circle.
width = param.Integer(allow_refs=True, bounds=(0, None), default=20, inclusive_bounds=(True, True), label=’Width’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174f0b150>): Width of the circle.
color = param.ObjectSelector(allow_refs=True, default=’dark’, label=’Color’, names={}, nested_refs=False, objects=[‘primary’, ‘secondary’, ‘success’, ‘info’, ‘danger’, ‘warning’, ‘light’, ‘dark’], rx=<param.reactive.reactive_ops object at 0x174f0a3d0>): The color of the circle, one of ‘primary’, ‘secondary’, ‘success’, ‘info’, ‘danger’, ‘warning’, ‘light’, ‘dark’

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.indicators.Dial(*, annulus_width, background, bounds, colors, default_color, end_angle, format, label_color, nan_format, needle_color, needle_width, start_angle, tick_size, title_size, unfilled_color, value_size, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: ValueIndicator

A Dial represents a value in some range as a position on an annular dial. It is similar to a Gauge but more minimal visually.

Reference: https://panel.holoviz.org/reference/indicators/Dial.html

Example:

>>> Dial(name='Speed', value=79, format="{value} km/h", bounds=(0, 200), colors=[(0.4, 'green'), (1, 'red')])

Parameters inherited from:

value = param.Number(allow_None=True, allow_refs=False, default=25, inclusive_bounds=(True, True), label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174f2c550>): Value to indicate on the dial a value within the declared bounds.
height = param.Integer(allow_refs=False, bounds=(1, None), default=250, inclusive_bounds=(True, True), label=’Height’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174f2e350>): The height of the component (in pixels). This can be either fixed or preferred height, depending on height sizing policy.
width = param.Integer(allow_refs=False, bounds=(1, None), default=250, inclusive_bounds=(True, True), label=’Width’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174f2c4d0>): The width of the component (in pixels). This can be either fixed or preferred width, depending on width sizing policy.
annulus_width = param.Number(allow_refs=False, default=0.2, inclusive_bounds=(True, True), label=’Annulus width’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174f2e290>): Width of the radial annulus as a fraction of the total.
background = param.Parameter(allow_None=True, allow_refs=False, label=’Background’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174cfec10>): Background color of the component.
bounds = param.Range(allow_refs=False, default=(0, 100), inclusive_bounds=(True, True), label=’Bounds’, length=2, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1747f44d0>): The upper and lower bound of the dial.
colors = param.List(allow_None=True, allow_refs=False, bounds=(0, None), label=’Colors’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174f2bb90>): Color thresholds for the Dial, specified as a list of tuples of the fractional threshold and the color to switch to.
default_color = param.String(allow_refs=False, default=’lightblue’, label=’Default color’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174f2cc10>): Color of the radial annulus if not color thresholds are supplied.
end_angle = param.Number(allow_refs=False, default=25, inclusive_bounds=(True, True), label=’End angle’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174f2d390>): Angle at which the dial ends.
format = param.String(allow_refs=False, default=’{value}%’, label=’Format’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174f2d110>): Formatting string for the value indicator and lower/upper bounds.
label_color = param.String(allow_refs=False, default=’black’, label=’Label color’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174f2ba50>): Color for all extraneous labels.
nan_format = param.String(allow_refs=False, default=’-’, label=’Nan format’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174f2bc10>): How to format nan values.
needle_color = param.String(allow_refs=False, default=’black’, label=’Needle color’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174f2ba50>): Color of the Dial needle.
needle_width = param.Number(allow_refs=False, default=0.1, inclusive_bounds=(True, True), label=’Needle width’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174f2d690>): Radial width of the needle.
start_angle = param.Number(allow_refs=False, default=-205, inclusive_bounds=(True, True), label=’Start angle’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174f2d8d0>): Angle at which the dial starts.
tick_size = param.String(allow_None=True, allow_refs=False, label=’Tick size’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174f2bc10>): Font size of the Dial min/max labels.
title_size = param.String(allow_None=True, allow_refs=False, label=’Title size’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174f2ba50>): Font size of the Dial title.
unfilled_color = param.String(allow_refs=False, default=’whitesmoke’, label=’Unfilled color’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174f2bc10>): Color of the unfilled region of the Dial.
value_size = param.String(allow_None=True, allow_refs=False, label=’Value size’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174f2ba50>): Font size of the Dial value label.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.indicators.Gauge(*, annulus_width, bounds, colors, custom_opts, end_angle, format, num_splits, show_labels, show_ticks, start_angle, title_size, tooltip_format, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: ValueIndicator

A Gauge represents a value in some range as a position on speedometer or gauge. It is similar to a Dial but visually a lot busier.

Reference: https://panel.holoviz.org/reference/indicators/Gauge.html

Example:

>>> Gauge(name='Speed', value=79, bounds=(0, 200), colors=[(0.4, 'green'), (1, 'red')])

Parameters inherited from:

value = param.Number(allow_refs=False, default=25, inclusive_bounds=(True, True), label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174f46b10>): Value to indicate on the gauge a value within the declared bounds.
height = param.Integer(allow_refs=False, bounds=(0, None), default=300, inclusive_bounds=(True, True), label=’Height’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174f50950>): The height of the component (in pixels). This can be either fixed or preferred height, depending on height sizing policy.
width = param.Integer(allow_refs=False, bounds=(0, None), default=300, inclusive_bounds=(True, True), label=’Width’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174f46a50>): The width of the component (in pixels). This can be either fixed or preferred width, depending on width sizing policy.
annulus_width = param.Integer(allow_refs=False, default=10, inclusive_bounds=(True, True), label=’Annulus width’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174f50890>): Width of the gauge annulus.
bounds = param.Range(allow_refs=False, default=(0, 100), inclusive_bounds=(True, True), label=’Bounds’, length=2, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174f467d0>): The upper and lower bound of the dial.
colors = param.List(allow_None=True, allow_refs=False, bounds=(0, None), label=’Colors’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174f46b10>): Color thresholds for the Gauge, specified as a list of tuples of the fractional threshold and the color to switch to.
custom_opts = param.Dict(allow_None=True, allow_refs=False, class_=<class ‘dict’>, label=’Custom opts’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174d83850>): Additional options to pass to the ECharts Gauge definition.
end_angle = param.Number(allow_refs=False, default=-45, inclusive_bounds=(True, True), label=’End angle’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174f45150>): Angle at which the gauge ends.
format = param.String(allow_refs=False, default=’{value}%’, label=’Format’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174f454d0>): Formatting string for the value indicator.
num_splits = param.Integer(allow_refs=False, default=10, inclusive_bounds=(True, True), label=’Num splits’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174f45150>): Number of splits along the gauge.
show_ticks = param.Boolean(allow_refs=False, default=True, label=’Show ticks’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174f455d0>): Whether to show ticks along the dials.
show_labels = param.Boolean(allow_refs=False, default=True, label=’Show labels’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174f46b90>): Whether to show tick labels along the dials.
start_angle = param.Number(allow_refs=False, default=225, inclusive_bounds=(True, True), label=’Start angle’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174f447d0>): Angle at which the gauge starts.
tooltip_format = param.String(allow_refs=False, default=’{b}{c}%’, label=’Tooltip format’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174f46b90>): Formatting string for the hover tooltip.
title_size = param.Integer(allow_refs=False, default=18, inclusive_bounds=(True, True), label=’Title size’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174f447d0>): Size of title font.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.indicators.LinearGauge(*, bounds, colors, default_color, format, horizontal, nan_format, needle_color, show_boundaries, tick_size, title_size, unfilled_color, value_size, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: ValueIndicator

A LinearGauge represents a value in some range as a position on an linear scale. It is similar to a Dial/Gauge but visually more compact.

Reference: https://panel.holoviz.org/reference/indicators/LinearGauge.html

Example:

>>> LinearGauge(value=30, default_color='red', bounds=(0, 100))

Parameters inherited from:

value = param.Number(allow_None=True, allow_refs=False, default=25, inclusive_bounds=(True, True), label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174f3c790>): Value to indicate on the dial a value within the declared bounds.
height = param.Integer(allow_refs=False, bounds=(1, None), default=300, inclusive_bounds=(True, True), label=’Height’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174f651d0>): The height of the component (in pixels). This can be either fixed or preferred height, depending on height sizing policy.
width = param.Integer(allow_refs=False, bounds=(1, None), default=125, inclusive_bounds=(True, True), label=’Width’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174f6f0d0>): The width of the component (in pixels). This can be either fixed or preferred width, depending on width sizing policy.
bounds = param.Range(allow_refs=False, default=(0, 100), inclusive_bounds=(True, True), label=’Bounds’, length=2, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174f3c4d0>): The upper and lower bound of the gauge.
default_color = param.String(allow_refs=False, default=’lightblue’, label=’Default color’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174f6ead0>): Color of the radial annulus if not color thresholds are supplied.
colors = param.Parameter(allow_None=True, allow_refs=False, label=’Colors’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174f6f450>): Color thresholds for the gauge, specified as a list of tuples of the fractional threshold and the color to switch to.
format = param.String(allow_refs=False, default=’{value:.2f}%’, label=’Format’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174f6ed50>): Formatting string for the value indicator and lower/upper bounds.
horizontal = param.Boolean(allow_refs=False, default=False, label=’Horizontal’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174f6f450>): Whether to display the linear gauge horizontally.
nan_format = param.String(allow_refs=False, default=’-’, label=’Nan format’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174f6ed50>): How to format nan values.
needle_color = param.String(allow_refs=False, default=’black’, label=’Needle color’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174f6f4d0>): Color of the gauge needle.
show_boundaries = param.Boolean(allow_refs=False, default=False, label=’Show boundaries’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174f6ea50>): Whether to show the boundaries between colored regions.
unfilled_color = param.String(allow_refs=False, default=’whitesmoke’, label=’Unfilled color’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174f6f4d0>): Color of the unfilled region of the LinearGauge.
title_size = param.String(allow_None=True, allow_refs=False, label=’Title size’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174f6eb50>): Font size of the gauge title.
tick_size = param.String(allow_None=True, allow_refs=False, label=’Tick size’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174f6f4d0>): Font size of the gauge tick labels.
value_size = param.String(allow_None=True, allow_refs=False, label=’Value size’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174f6eb50>): Font size of the gauge value label.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.indicators.LoadingSpinner(*, bgcolor, color, size, throttle, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: BooleanIndicator

The LoadingSpinner is a boolean indicator providing a visual representation of the loading status.

If the value is set to True the spinner will rotate while setting it to False will disable the rotating segment.

Reference: https://panel.holoviz.org/reference/indicators/LoadingSpinner.html

Example:

>>> LoadingSpinner(value=True, color='primary', bgcolor='light', width=100, height=100)

Parameters inherited from:

value = param.Boolean(allow_refs=True, default=False, label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174f90110>): Whether the indicator is active or not.

bgcolor = param.ObjectSelector(allow_refs=True, default=’light’, label=’Bgcolor’, names={}, nested_refs=False, objects=[‘dark’, ‘light’], rx=<param.reactive.reactive_ops object at 0x174f93490>)

color = param.ObjectSelector(allow_refs=True, default=’dark’, label=’Color’, names={}, nested_refs=False, objects=[‘primary’, ‘secondary’, ‘success’, ‘info’, ‘danger’, ‘warning’, ‘light’, ‘dark’], rx=<param.reactive.reactive_ops object at 0x174f93810>)

size = param.Integer(allow_refs=True, default=125, inclusive_bounds=(True, True), label=’Size’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174f93a50>): Size of the spinner in pixels.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.indicators.Number(*, colors, default_color, font_size, format, nan_format, title_size, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: ValueIndicator

The Number indicator renders the value as text optionally colored according to the colors thresholds.

Reference: https://panel.holoviz.org/reference/indicators/Number.html

Example:

>>> Number(name='Rate', value=72, format='{value}%', colors=[(80, 'green'), (100, 'red')]

Parameters inherited from:

default_color = param.String(allow_refs=False, default=’black’, label=’Default color’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174face50>): The color of the Number indicator if no colors are provided
colors = param.List(allow_None=True, allow_refs=False, bounds=(0, None), label=’Colors’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174fae750>): Color thresholds for the Number indicator, specified as a tuple of the absolute thresholds and the color to switch to.
format = param.String(allow_refs=False, default=’{value}’, label=’Format’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174facd90>): A formatter string which accepts a {value}.
font_size = param.String(allow_refs=False, default=’54pt’, label=’Font size’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174fae3d0>): The size of number itself.
nan_format = param.String(allow_refs=False, default=’-’, label=’Nan format’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174fae8d0>): How to format nan values.
title_size = param.String(allow_refs=False, default=’18pt’, label=’Title size’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174face50>): The size of the title given by the name.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.indicators.Progress(*, active, bar_color, max, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: ValueIndicator

The Progress widget displays the progress towards some target based on the current value and the max value.

If no value is set, the Progress widget is in indeterminate mode and will animate depending on whether it is active or not. A more beautiful indicator for this use case is the LoadingSpinner.

Reference: https://panel.holoviz.org/reference/indicators/Progress.html

Example:

>>> Progress(value=20, max=100, bar_color="primary")

Parameters inherited from:

value = param.Integer(allow_refs=False, bounds=(-1, None), default=-1, inclusive_bounds=(True, True), label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174fb4610>): The current value of the progress bar. If set to -1 the progress bar will be indeterminate and animate depending on the active parameter.
width = param.Integer(allow_refs=False, bounds=(0, None), default=300, inclusive_bounds=(True, True), label=’Width’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174fb6410>): The width of the component (in pixels). This can be either fixed or preferred width, depending on width sizing policy.
sizing_mode = param.ObjectSelector(allow_refs=False, label=’Sizing mode’, names={}, nested_refs=False, objects=[‘fixed’, ‘stretch_width’, ‘stretch_height’, ‘stretch_both’, ‘scale_width’, ‘scale_height’, ‘scale_both’, None], rx=<param.reactive.reactive_ops object at 0x174fbff90>): How the component should size itself. This is a high-level setting for maintaining width and height of the component. To gain more fine grained control over sizing, use width_policy, height_policy and aspect_ratio instead (those take precedence over sizing_mode). "fixed" Component is not responsive. It will retain its original width and height regardless of any subsequent browser window resize events. "stretch_width" Component will responsively resize to stretch to the available width, without maintaining any aspect ratio. The height of the component depends on the type of the component and may be fixed or fit to component’s contents. "stretch_height" Component will responsively resize to stretch to the available height, without maintaining any aspect ratio. The width of the component depends on the type of the component and may be fixed or fit to component’s contents. "stretch_both" Component is completely responsive, independently in width and height, and will occupy all the available horizontal and vertical space, even if this changes the aspect ratio of the component. "scale_width" Component will responsively resize to stretch to the available width, while maintaining the original or provided aspect ratio. "scale_height" Component will responsively resize to stretch to the available height, while maintaining the original or provided aspect ratio. "scale_both" Component will responsively resize to both the available width and height, while maintaining the original or provided aspect ratio.
active = param.Boolean(allow_refs=False, default=True, label=’Active’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174fb5b50>): If no value is set the active property toggles animation of the progress bar on and off.

bar_color = param.ObjectSelector(allow_refs=False, default=’success’, label=’Bar color’, names={}, nested_refs=False, objects=[‘primary’, ‘secondary’, ‘success’, ‘info’, ‘danger’, ‘warning’, ‘light’, ‘dark’], rx=<param.reactive.reactive_ops object at 0x174fb42d0>)

max = param.Integer(allow_refs=False, default=100, inclusive_bounds=(True, True), label=’Max’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174fb6410>): The maximum value of the progress bar.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

sizing_mode = None#

class panel.widgets.indicators.String(*, default_color, font_size, title_size, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: ValueIndicator

The String indicator renders a string with a title.

Parameters inherited from:

value = param.String(allow_None=True, allow_refs=False, label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174f9c790>): The string to display
default_color = param.String(allow_refs=False, default=’black’, label=’Default color’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174fc6e10>): The color of the Number indicator if no colors are provided
font_size = param.String(allow_refs=False, default=’54pt’, label=’Font size’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174f9c790>): The size of number itself.
title_size = param.String(allow_refs=False, default=’18pt’, label=’Title size’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x174fc5750>): The size of the title given by the name.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.indicators.TooltipIcon(**params: Any)[source]#

Bases: Widget

The TooltipIcon displays a small ? icon. When you hover over the ? icon, the value will display.

Use the TooltipIcon to provide

helpful information to users without taking up a lot of screen space
tooltips next to Panel widgets that do not support tooltips yet.

Reference: https://panel.holoviz.org/reference/indicators/TooltipIcon.html

Example:

>>> pn.widgets.TooltipIcon(value="This is a simple tooltip by using a string")

Parameters inherited from:

value = param.ClassSelector(allow_refs=False, class_=(<class ‘str’>, <class ‘bokeh.models.ui.tooltips.Tooltip’>), default=’Description’, label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17500a890>): The description in the tooltip.
align = param.Align(allow_refs=False, default=’center’, label=’Align’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17500bf50>): Whether the object should be aligned with the start, end or center of its container. If set as a tuple it will declare (vertical, horizontal) alignment.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.indicators.Tqdm(*, layout, lock, max, progress, text, text_pane, write_to_console, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: Indicator

The Tqdm indicator wraps the well known tqdm progress indicator and displays the progress towards some target in your Panel app.

Reference: https://panel.holoviz.org/reference/indicators/Tqdm.html

Example:

>>> tqdm = Tqdm()
>>> for i in tqdm(range(0,10), desc="My loop", leave=True, colour='#666666'):
...     time.sleep(timeout)

Parameters inherited from:

value = param.Integer(allow_refs=False, bounds=(-1, None), default=0, inclusive_bounds=(True, True), label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1750296d0>): The current value of the progress bar. If set to -1 the progress bar will be indeterminate and animate depending on the active parameter.
margin = param.Parameter(allow_refs=False, default=0, label=’Margin’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17502af90>): Allows to create additional space around the component. May be specified as a two-tuple of the form (vertical, horizontal) or a four-tuple (top, right, bottom, left).
width = param.Integer(allow_refs=False, bounds=(0, None), default=400, inclusive_bounds=(True, True), label=’Width’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x175029610>): The width of the component (in pixels). This can be either fixed or preferred width, depending on width sizing policy.
layout = param.ClassSelector(allow_None=True, allow_refs=False, class_=(<class ‘panel.layout.base.Column’>, <class ‘panel.layout.base.Row’>), constant=True, label=’Layout’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17502b150>): The layout for the text and progress indicator.
lock = param.ClassSelector(allow_None=True, allow_refs=False, class_=<class ‘object’>, label=’Lock’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x175028f10>): The multithreading.Lock or multiprocessing.Lock object to be used by Tqdm.
max = param.Integer(allow_refs=False, default=100, inclusive_bounds=(True, True), label=’Max’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x175029890>): The maximum value of the progress bar.
progress = param.ClassSelector(allow_None=True, allow_refs=False, class_=<class ‘panel.widgets.indicators.Progress’>, label=’Progress’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x175029210>): The Progress indicator used to display the progress.
text = param.String(allow_refs=False, default=’’, label=’Text’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17502af90>): The current tqdm style progress text.
text_pane = param.ClassSelector(allow_None=True, allow_refs=False, class_=<class ‘panel.pane.markup.Str’>, label=’Text pane’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17502b2d0>): The pane to display the text to.
write_to_console = param.Boolean(allow_refs=False, default=False, label=’Write to console’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17502ac50>): Whether or not to also write to the console.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

reset()[source]#: Resets the parameters

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.indicators.Trend(*, data, layout, neg_color, plot_color, plot_type, plot_x, plot_y, pos_color, value_change, selection, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: SyncableData, Indicator

The Trend indicator enables the user to display a dashboard kpi card.

The card can be layout out as:

a column (text and plot on top of each other) or a row (text and
plot after each other)

Reference: https://panel.holoviz.org/reference/indicators/Trend.html

Example:

>>> data = {'x': np.arange(50), 'y': np.random.randn(50).cumsum()}
>>> Trend(name='Price', data=data, plot_type='area', width=200, height=200)

Parameters inherited from:

value = param.Parameter(allow_refs=False, default=’auto’, label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x175027c90>): The primary value to be displayed.
sizing_mode = param.ObjectSelector(allow_refs=False, label=’Sizing mode’, names={}, nested_refs=False, objects=[‘fixed’, ‘stretch_width’, ‘stretch_height’, ‘stretch_both’, ‘scale_width’, ‘scale_height’, ‘scale_both’, None], rx=<param.reactive.reactive_ops object at 0x175041910>): How the component should size itself. This is a high-level setting for maintaining width and height of the component. To gain more fine grained control over sizing, use width_policy, height_policy and aspect_ratio instead (those take precedence over sizing_mode). "fixed" Component is not responsive. It will retain its original width and height regardless of any subsequent browser window resize events. "stretch_width" Component will responsively resize to stretch to the available width, without maintaining any aspect ratio. The height of the component depends on the type of the component and may be fixed or fit to component’s contents. "stretch_height" Component will responsively resize to stretch to the available height, without maintaining any aspect ratio. The width of the component depends on the type of the component and may be fixed or fit to component’s contents. "stretch_both" Component is completely responsive, independently in width and height, and will occupy all the available horizontal and vertical space, even if this changes the aspect ratio of the component. "scale_width" Component will responsively resize to stretch to the available width, while maintaining the original or provided aspect ratio. "scale_height" Component will responsively resize to stretch to the available height, while maintaining the original or provided aspect ratio. "scale_both" Component will responsively resize to both the available width and height, while maintaining the original or provided aspect ratio.
data = param.Parameter(allow_None=True, allow_refs=False, label=’Data’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x175027c90>): The plot data declared as a dictionary of arrays or a DataFrame.

layout = param.ObjectSelector(allow_refs=False, default=’column’, label=’Layout’, names={}, nested_refs=False, objects=[‘column’, ‘row’], rx=<param.reactive.reactive_ops object at 0x1750417d0>)

plot_x = param.String(allow_refs=False, default=’x’, label=’Plot x’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x175040350>): The name of the key in the plot_data to use on the x-axis.
plot_y = param.String(allow_refs=False, default=’y’, label=’Plot y’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x175041490>): The name of the key in the plot_data to use on the y-axis.
plot_color = param.String(allow_refs=False, default=’#428bca’, label=’Plot color’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x175041b10>): The color to use in the plot.
plot_type = param.ObjectSelector(allow_refs=False, default=’bar’, label=’Plot type’, names={}, nested_refs=False, objects=[‘line’, ‘step’, ‘area’, ‘bar’], rx=<param.reactive.reactive_ops object at 0x175041a10>): The plot type to render the plot data as.
pos_color = param.String(allow_refs=False, default=’#5cb85c’, label=’Pos color’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1750417d0>): The color used to indicate a positive change.
neg_color = param.String(allow_refs=False, default=’#d9534f’, label=’Neg color’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x175041990>): The color used to indicate a negative change.
value_change = param.Parameter(allow_refs=False, default=’auto’, label=’Value change’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x175040450>): A secondary value. For example the change in percent.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

patch(patch_value: 'pd.DataFrame' | 'pd.Series' | dict) → None[source]#

Efficiently patches (updates) the existing value with the patch_value.

Arguments#

patch_value: (pd.DataFrame | pd.Series | Dict): The value(s) to patch the existing value with.

Raises#

ValueError: Raised if the patch_value is not a supported type.

Examples#

Patch a DataFrame with a Dictionary row. >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> obj = DataComponent(value) >>> patch_value = {“x”: [(0, 3)]} >>> obj.patch(patch_value) >>> obj.value.to_dict(“list”) {‘x’: [3, 2], ‘y’: [‘a’, ‘b’]}

Patch a Dataframe with a Dictionary of Columns. >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> obj = DataComponent(value) >>> patch_value = {“x”: [(slice(2), (3,4))], “y”: [(1,’d’)]} >>> obj.patch(patch_value) >>> obj.value.to_dict(“list”) {‘x’: [3, 4], ‘y’: [‘a’, ‘d’]}

Patch a DataFrame with a Series. Please note the index is used in the update. >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> obj = DataComponent(value) >>> patch_value = pd.Series({“index”: 1, “x”: 4, “y”: “d”}) >>> obj.patch(patch_value) >>> obj.value.to_dict(“list”) {‘x’: [1, 4], ‘y’: [‘a’, ‘d’]}

Patch a Dataframe with a Dataframe. Please note the index is used in the update. >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> obj = DataComponent(value) >>> patch_value = pd.DataFrame({“x”: [3, 4], “y”: [“c”, “d”]}) >>> obj.patch(patch_value) >>> obj.value.to_dict(“list”) {‘x’: [3, 4], ‘y’: [‘c’, ‘d’]}

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

sizing_mode = None#

stream(stream_value: 'pd.DataFrame' | 'pd.Series' | dict, rollover: int | None = None, reset_index: bool = True) → None[source]#

Streams (appends) the stream_value provided to the existing value in an efficient manner.

Arguments#

stream_value: (pd.DataFrame | pd.Series | Dict): The new value(s) to append to the existing value.
rollover: (int | None, default=None): A maximum column size, above which data from the start of the column begins to be discarded. If None, then columns will continue to grow unbounded.
reset_index (bool, default=True):: If True and the stream_value is a DataFrame, then its index is reset. Helps to keep the index unique and named index.

Raises#

ValueError: Raised if the stream_value is not a supported type.

Examples#

Stream a Series to a DataFrame >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> obj = DataComponent(value) >>> stream_value = pd.Series({“x”: 4, “y”: “d”}) >>> obj.stream(stream_value) >>> obj.value.to_dict(“list”) {‘x’: [1, 2, 4], ‘y’: [‘a’, ‘b’, ‘d’]}

Stream a Dataframe to a Dataframe >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> obj = DataComponent(value) >>> stream_value = pd.DataFrame({“x”: [3, 4], “y”: [“c”, “d”]}) >>> obj.stream(stream_value) >>> obj.value.to_dict(“list”) {‘x’: [1, 2, 3, 4], ‘y’: [‘a’, ‘b’, ‘c’, ‘d’]}

Stream a Dictionary row to a DataFrame >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> tabulator = DataComponent(value) >>> stream_value = {“x”: 4, “y”: “d”} >>> obj.stream(stream_value) >>> obj.value.to_dict(“list”) {‘x’: [1, 2, 4], ‘y’: [‘a’, ‘b’, ‘d’]}

Stream a Dictionary of Columns to a Dataframe >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> obj = DataComponent(value) >>> stream_value = {“x”: [3, 4], “y”: [“c”, “d”]} >>> obj.stream(stream_value) >>> obj.value.to_dict(“list”) {‘x’: [1, 2, 3, 4], ‘y’: [‘a’, ‘b’, ‘c’, ‘d’]}

class panel.widgets.indicators.ValueIndicator(**params: Any)[source]#

Bases: Indicator

A ValueIndicator provides a visual representation for a numeric value.

Parameters inherited from:

value = param.Number(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1750793d0>): The widget value which the widget type resolves to when used as a reactive param reference.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

`input` Module#

The input widgets generally allow entering arbitrary information into a text field or similar.

class panel.widgets.input.ArrayInput(*, max_array_size, description, placeholder, serializer, type, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: LiteralInput

The ArrayInput allows rendering and editing NumPy arrays in a text input widget.

Arrays larger than the max_array_size will be summarized and editing will be disabled.

Reference: https://panel.holoviz.org/reference/widgets/ArrayInput.html

Example:

>>> To be determined ...

Parameters inherited from:

max_array_size = param.Number(allow_refs=False, default=1000, inclusive_bounds=(True, True), label=’Max array size’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x173951510>): Arrays larger than this limit will be allowed in Python but will not be serialized into JavaScript. Although such large arrays will thus not be editable in the widget, such a restriction helps avoid overwhelming the browser and lets other widgets remain usable.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.input.Checkbox(**params: Any)[source]#

Bases: _BooleanWidget

The Checkbox allows toggling a single condition between True/False states by ticking a checkbox.

This widget is interchangeable with the Toggle widget.

Reference: https://panel.holoviz.org/reference/widgets/Checkbox.html

Example:

>>> Checkbox(name='Works with the tools you know and love', value=True)

Parameters inherited from:

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.input.ColorPicker(**params: Any)[source]#

Bases: Widget

The ColorPicker widget allows selecting a hexadecimal RGB color value using the browser’s color-picking widget.

Reference: https://panel.holoviz.org/reference/widgets/ColorPicker.html

Example:

>>> ColorPicker(name='Color', value='#99ef78')

Parameters inherited from:

value = param.Color(allow_None=True, allow_named=True, allow_refs=False, label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1734b0690>): The selected color
width = param.Integer(allow_None=True, allow_refs=False, bounds=(0, None), default=52, inclusive_bounds=(True, True), label=’Width’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1734c4090>): Width of this component. If sizing_mode is set to stretch or scale mode this will merely be used as a suggestion.
description = param.String(allow_None=True, allow_refs=False, label=’Description’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1734b2310>): An HTML string describing the function of this component.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.input.DatePicker(*, description, disabled_dates, enabled_dates, end, start, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: Widget

The DatePicker allows selecting a date value using a text box and a date-picking utility.

Reference: https://panel.holoviz.org/reference/widgets/DatePicker.html

Example:

>>> DatePicker(
...     value=date(2025,1,1),
...     start=date(2025,1,1), end=date(2025,12,31),
...     name='Date'
... )

Parameters inherited from:

value = param.CalendarDate(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17341fe10>): The current value
width = param.Integer(allow_None=True, allow_refs=False, bounds=(0, None), default=300, inclusive_bounds=(True, True), label=’Width’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x173345ed0>): Width of this component. If sizing_mode is set to stretch or scale mode this will merely be used as a suggestion.
start = param.CalendarDate(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’Start’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17341ff10>): Inclusive lower bound of the allowed date selection
end = param.CalendarDate(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’End’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x173346190>): Inclusive upper bound of the allowed date selection

disabled_dates = param.List(allow_None=True, allow_refs=False, bounds=(0, None), class_=(<class ‘datetime.date’>, <class ‘str’>), item_type=(<class ‘datetime.date’>, <class ‘str’>), label=’Disabled dates’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x173317790>)

enabled_dates = param.List(allow_None=True, allow_refs=False, bounds=(0, None), class_=(<class ‘datetime.date’>, <class ‘str’>), item_type=(<class ‘datetime.date’>, <class ‘str’>), label=’Enabled dates’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1733451d0>)

description = param.String(allow_None=True, allow_refs=False, label=’Description’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x173316bd0>): An HTML string describing the function of this component.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.input.DateRangePicker(*, description, disabled_dates, enabled_dates, end, start, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: Widget

The DateRangePicker allows selecting a date range using a text box and a date-picking utility.

Reference: https://panel.holoviz.org/reference/widgets/DateRangePicker.html

Example:

>>> DateRangePicker(
...     value=(date(2025,1,1), date(2025,1,5)),
...     start=date(2025,1,1), end=date(2025,12,31),
...     name='Date range'
... )

Parameters inherited from:

value = param.DateRange(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’Value’, length=2, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1732162d0>): The current value
width = param.Integer(allow_None=True, allow_refs=False, bounds=(0, None), default=300, inclusive_bounds=(True, True), label=’Width’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x172f47a10>): Width of this component. If sizing_mode is set to stretch or scale mode this will merely be used as a suggestion.
start = param.CalendarDate(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’Start’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x173215a10>): Inclusive lower bound of the allowed date selection
end = param.CalendarDate(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’End’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17352f090>): Inclusive upper bound of the allowed date selection

disabled_dates = param.List(allow_None=True, allow_refs=False, bounds=(0, None), class_=(<class ‘datetime.date’>, <class ‘str’>), item_type=(<class ‘datetime.date’>, <class ‘str’>), label=’Disabled dates’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1732162d0>)

enabled_dates = param.List(allow_None=True, allow_refs=False, bounds=(0, None), class_=(<class ‘datetime.date’>, <class ‘str’>), item_type=(<class ‘datetime.date’>, <class ‘str’>), label=’Enabled dates’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17352f090>)

description = param.String(allow_None=True, allow_refs=False, label=’Description’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x173216390>): An HTML string describing the function of this component.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.input.DatetimeInput(*, end, format, start, description, placeholder, serializer, type, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: LiteralInput

The DatetimeInput allows specifying Python datetime like values using a text input widget.

An optional type may be declared.

Reference: https://panel.holoviz.org/reference/widgets/DatetimeInput.html

Example:

>>> DatetimeInput(name='Datetime', value=datetime(2019, 2, 8))

Parameters inherited from:

value = param.Date(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x172f4aed0>): The current value
start = param.Date(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’Start’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x172f4e890>): Inclusive lower bound of the allowed date selection
end = param.Date(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’End’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x172f4a810>): Inclusive upper bound of the allowed date selection
format = param.String(allow_refs=False, default=’%Y-%m-%d %H:%M:%S’, label=’Format’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x172f4c5d0>): Datetime format used for parsing and formatting the datetime.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

type[source]#: alias of datetime

class panel.widgets.input.DatetimePicker(*, mode, as_numpy_datetime64, description, disabled_dates, enable_seconds, enable_time, enabled_dates, end, military_time, start, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: _DatetimePickerBase

The DatetimePicker allows selecting selecting a datetime value using a textbox and a datetime-picking utility.

Reference: https://panel.holoviz.org/reference/widgets/DatetimePicker.html

Example:

>>> DatetimePicker(
...    value=datetime(2025,1,1,22,0),
...    start=date(2025,1,1), end=date(2025,12,31),
...    military_time=True, name='Date and time'
... )

Parameters inherited from:

value = param.Date(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x172cc6f90>): The widget value which the widget type resolves to when used as a reactive param reference.

mode = param.String(allow_refs=False, constant=True, default=’single’, label=’Mode’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x172bf5c50>)

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.input.DatetimeRangeInput(*, end, format, start, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: CompositeWidget

The DatetimeRangeInput widget allows selecting a datetime range using two DatetimeInput widgets, which return a tuple range.

Reference: https://panel.holoviz.org/reference/widgets/DatetimeRangeInput.html

Example:

>>> DatetimeRangeInput(
...     name='Datetime Range',
...     value=(datetime(2017, 1, 1), datetime(2018, 1, 10)),
...     start=datetime(2017, 1, 1), end=datetime(2019, 1, 1),
... )

Parameters inherited from:

value = param.Tuple(allow_refs=False, default=(None, None), label=’Value’, length=2, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x172b7eb50>): The current value
start = param.Date(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’Start’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x172b7cf50>): Inclusive lower bound of the allowed date selection
end = param.Date(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’End’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x172b7c950>): Inclusive upper bound of the allowed date selection
format = param.String(allow_refs=False, default=’%Y-%m-%d %H:%M:%S’, label=’Format’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x172b7d790>): Datetime format used for parsing and formatting the datetime.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.input.DatetimeRangePicker(*, mode, as_numpy_datetime64, description, disabled_dates, enable_seconds, enable_time, enabled_dates, end, military_time, start, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: _DatetimePickerBase

The DatetimeRangePicker allows selecting selecting a datetime range using a text box and a datetime-range-picking utility.

Reference: https://panel.holoviz.org/reference/widgets/DatetimeRangePicker.html

Example:

>>> DatetimeRangePicker(
...    value=(datetime(2025,1,1,22,0), datetime(2025,1,2,22,0)),
...    start=date(2025,1,1), end=date(2025,12,31),
...    military_time=True, name='Datetime Range'
... )

Parameters inherited from:

value = param.DateRange(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’Value’, length=2, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17296b250>): The current value

mode = param.String(allow_refs=False, constant=True, default=’range’, label=’Mode’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x172969a10>)

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.input.FileDropper(*, accepted_filetypes, chunk_size, layout, max_file_size, max_files, max_total_file_size, mime_type, multiple, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: Widget

The FileDropper allows the user to upload one or more files to the server.

It is similar to the FileInput widget but additionally adds support for chunked uploads, making it possible to upload large files. The UI also supports previews for image files. Unlike FileInput the uploaded files are stored as dictionary of bytes object indexed by the filename.

Reference: https://panel.holoviz.org/reference/widgets/FileDropper.html

Example:

>>> FileDropper(accepted_filetypes=['image/*'], multiple=True)

Parameters inherited from:

value = param.Dict(allow_refs=False, class_=<class ‘dict’>, default={}, label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1728a3c90>): A dictionary containing the uploaded file(s) as bytes or string objects indexed by the filename. Files that have a text/* mimetype will automatically be decoded as utf-8.
width = param.Integer(allow_None=True, allow_refs=False, bounds=(0, None), default=300, inclusive_bounds=(True, True), label=’Width’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1728dac50>): Width of this component. If sizing_mode is set to stretch or scale mode this will merely be used as a suggestion.
accepted_filetypes = param.List(allow_refs=False, bounds=(0, None), default=[], label=’Accepted filetypes’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1728a3810>): List of accepted file types. Can be mime types, file extensions or wild cards.For instance [‘image/*’] will accept all images. [‘.png’, ‘image/jpeg’] will only accepts PNGs and JPEGs.
chunk_size = param.Integer(allow_refs=False, default=10000000, inclusive_bounds=(True, True), label=’Chunk size’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1728d9490>): Size in bytes per chunk transferred across the WebSocket.
layout = param.Selector(allow_refs=False, label=’Layout’, names={}, nested_refs=False, objects=[‘circle’, ‘compact’, ‘integrated’], rx=<param.reactive.reactive_ops object at 0x1728a3c10>): Compact mode will remove padding, integrated mode is used to render FilePond as part of a bigger element. Circle mode adjusts the item position offsets so buttons and progress indicators don’t fall outside of the circular shape.
max_file_size = param.String(allow_None=True, allow_refs=False, label=’Max file size’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1728db4d0>): Maximum size of a file as a string with units given in KB or MB, e.g. 5MB or 750KB.
max_files = param.Integer(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’Max files’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1728db110>): Maximum number of files that can be uploaded if multiple=True.
max_total_file_size = param.String(allow_None=True, allow_refs=False, label=’Max total file size’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1728db590>): Maximum size of all uploaded files, as a string with units given in KB or MB, e.g. 5MB or 750KB.
mime_type = param.Dict(allow_refs=False, class_=<class ‘dict’>, default={}, label=’Mime type’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1728d9610>): A dictionary containing the mimetypes for each of the uploaded files indexed by their filename.
multiple = param.Boolean(allow_refs=False, default=False, label=’Multiple’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x173436ed0>): Whether to allow uploading multiple files.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.input.FileInput(**params: Any)[source]#

Bases: Widget

The FileInput allows the user to upload one or more files to the server.

It makes the filename, MIME type and (bytes) content available in Python.

Please note

you can in fact drag and drop files onto the FileInput.
you easily save the files using the save method.

Reference: https://panel.holoviz.org/reference/widgets/FileInput.html

Example:

>>> FileInput(accept='.png,.jpeg', multiple=True)

Parameters inherited from:

value = param.Parameter(allow_None=True, allow_refs=False, label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1727325d0>): The uploaded file(s) stored as a single bytes object if multiple is False or a list of bytes otherwise.
accept = param.String(allow_None=True, allow_refs=False, label=’Accept’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17262e150>): A comma separated string of all extension types that should be supported.
description = param.String(allow_None=True, allow_refs=False, label=’Description’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1727325d0>): An HTML string describing the function of this component rendered as a tooltip icon.
directory = param.Boolean(allow_refs=False, default=False, label=’Directory’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17262e590>): Whether to allow selection of directories instead of files. The filename will be relative paths to the uploaded directory. .. note:: When a directory is uploaded it will give add a confirmation pop up. The confirmation pop up cannot be disabled, as this is a security feature in the browser. .. note:: The accept parameter only works with file extension. When using accept with directory, the number of files reported will be the total amount of files, not the filtered.
filename = param.ClassSelector(allow_None=True, allow_refs=False, class_=(<class ‘str’>, <class ‘list’>), label=’Filename’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x172737c90>): Name of the uploaded file(s).
mime_type = param.ClassSelector(allow_None=True, allow_refs=False, class_=(<class ‘str’>, <class ‘list’>), label=’Mime type’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17262e150>): Mimetype of the uploaded file(s).
multiple = param.Boolean(allow_refs=False, default=False, label=’Multiple’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17275b910>): Whether to allow uploading multiple files. If enabled value parameter will return a list.

clear()[source]#: Clear the file(s) in the FileInput widget

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename)[source]#: Saves the uploaded FileInput data object(s) to file(s) or BytesIO object(s).

Arguments#

filename (str or list[str]): File path or file-like object

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.input.FloatInput(*, step, value_throttled, page_step_multiplier, wheel_wait, mode, description, end, format, placeholder, start, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: _SpinnerBase, _FloatInputBase

The FloatInput allows selecting a floating point value using a spinbox.

It behaves like a slider except that the lower and upper bounds are optional and a specific value can be entered. The value can be changed using the keyboard (up, down, page up, page down), mouse wheel and arrow buttons.

Reference: https://panel.holoviz.org/reference/widgets/FloatInput.html

Example:

>>> FloatInput(name='Value', value=5., step=1e-1, start=0, end=10)

Parameters inherited from:

placeholder = param.String(allow_refs=False, default=’’, label=’Placeholder’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1724dbdd0>): Placeholder when the value is empty.
step = param.Number(allow_refs=False, default=0.1, inclusive_bounds=(True, True), label=’Step’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17241bc50>): The step size.
value_throttled = param.Number(allow_None=True, allow_refs=False, constant=True, inclusive_bounds=(True, True), label=’Value throttled’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17241bb10>): The current value. Updates only on <enter> or when the widget looses focus.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.input.IntInput(*, step, value_throttled, page_step_multiplier, wheel_wait, mode, description, end, format, placeholder, start, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: _SpinnerBase, _IntInputBase

The IntInput allows selecting an integer value using a spinbox.

It behaves like a slider except that lower and upper bounds are optional and a specific value can be entered. The value can be changed using the keyboard (up, down, page up, page down), mouse wheel and arrow buttons.

Reference: https://panel.holoviz.org/reference/widgets/IntInput.html

Example:

>>> IntInput(name='Value', value=100, start=0, end=1000, step=10)

Parameters inherited from:

step = param.Integer(allow_refs=False, default=1, inclusive_bounds=(True, True), label=’Step’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x172414e90>): The step size.
value_throttled = param.Integer(allow_None=True, allow_refs=False, constant=True, inclusive_bounds=(True, True), label=’Value throttled’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x172338910>): The current value. Updates only on <enter> or when the widget looses focus.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.input.LiteralInput(*, description, placeholder, serializer, type, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: Widget

The LiteralInput allows declaring Python literals using a text input widget.

A literal is some specific primitive value of type str , int, float, bool etc or a dict, list, tuple, set etc of primitive values.

Optionally the literal type may be declared.

Reference: https://panel.holoviz.org/reference/widgets/LiteralInput.html

Example:

>>> LiteralInput(name='Dictionary', value={'key': [1, 2, 3]}, type=dict)

Parameters inherited from:

value = param.Parameter(allow_None=True, allow_refs=False, label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17222c150>): The widget value which the widget type resolves to when used as a reactive param reference.
width = param.Integer(allow_None=True, allow_refs=False, bounds=(0, None), default=300, inclusive_bounds=(True, True), label=’Width’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17222e0d0>): Width of this component. If sizing_mode is set to stretch or scale mode this will merely be used as a suggestion.
description = param.String(allow_None=True, allow_refs=False, label=’Description’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17222c150>): An HTML string describing the function of this component.
placeholder = param.String(allow_refs=False, default=’’, label=’Placeholder’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17222e3d0>): Placeholder for empty input field.
serializer = param.ObjectSelector(allow_refs=False, default=’ast’, label=’Serializer’, names={}, nested_refs=False, objects=[‘ast’, ‘json’], rx=<param.reactive.reactive_ops object at 0x17222de50>): The serialization (and deserialization) method to use. ‘ast’ uses ast.literal_eval and ‘json’ uses json.loads and json.dumps.

type = param.ClassSelector(allow_None=True, allow_refs=False, class_=(<class ‘type’>, <class ‘tuple’>), label=’Type’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17222ead0>)

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.input.NumberInput(*, page_step_multiplier, wheel_wait, description, end, format, placeholder, start, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: _SpinnerBase

Parameters inherited from:

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.input.PasswordInput(**params: Any)[source]#

Bases: _TextInputBase

The PasswordInput allows entering any string using an obfuscated text input box.

Reference: https://panel.holoviz.org/reference/widgets/PasswordInput.html

Example:

>>> PasswordInput(
...     name='Password', placeholder='Enter your password here...'
... )

Parameters inherited from:

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, onkeyup=False, **params) → Viewable[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.
onkeyup: boolean: Whether to trigger events on every key press.
params: dict: Keyword arguments to be passed to the widget constructor

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

panel.widgets.input.Spinner[source]#: alias of NumberInput

class panel.widgets.input.StaticText(**params: Any)[source]#

Bases: Widget

The StaticText widget displays a text value, but does not allow editing it.

Reference: https://panel.holoviz.org/reference/widgets/StaticText.html

Example:

>>> StaticText(name='Model', value='animagen2')

Parameters inherited from:

value = param.Parameter(allow_None=True, allow_refs=False, label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x171d6a910>): The current value to be displayed.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.input.Switch(**params: Any)[source]#

Bases: _BooleanWidget

The Switch allows toggling a single condition between True/False states by ticking a checkbox.

This widget is interchangeable with the Toggle widget.

Reference: https://panel.holoviz.org/reference/widgets/Switch.html

Example:

>>> Switch(name='Works with the tools you know and love', value=True)

Parameters inherited from:

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.input.TextAreaInput(**params: Any)[source]#

Bases: _TextInputBase

`.

Parameters inherited from:

auto_grow = param.Boolean(allow_refs=False, default=False, label=’Auto grow’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1718e8a10>): Whether the text area should automatically grow vertically to accommodate the current text.
cols = param.Integer(allow_refs=False, default=20, inclusive_bounds=(True, True), label=’Cols’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x171a2c610>): Number of columns in the text input field.
max_rows = param.Integer(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’Max rows’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x171a2cc90>): When combined with auto_grow this determines the maximum number of rows the input area can grow.
rows = param.Integer(allow_refs=False, default=2, inclusive_bounds=(True, True), label=’Rows’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x171a2c6d0>): Number of rows in the text input field.
resizable = param.ObjectSelector(allow_refs=False, label=’Resizable’, names={}, nested_refs=False, objects=[‘both’, ‘width’, ‘height’, False], rx=<param.reactive.reactive_ops object at 0x1718e8cd0>): Whether the layout is interactively resizable, and if so in which dimensions: width, height, or both. Can only be set during initialization.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, onkeyup=False, **params) → Viewable[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.
onkeyup: boolean: Whether to trigger events on every key press.
params: dict: Keyword arguments to be passed to the widget constructor

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.input.TextInput(**params: Any)[source]#

Bases: _TextInputBase

The TextInput widget allows entering any string using a text input box.

Reference: https://panel.holoviz.org/reference/widgets/TextInput.html

Example:

>>> TextInput(name='Name', placeholder='Enter your name here ...')

Parameters inherited from:

enter_pressed = param.Event(allow_refs=True, default=False, label=’Enter pressed’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1718f3e10>): Event when the enter key has been pressed.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, onkeyup=False, **params) → Viewable[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.
onkeyup: boolean: Whether to trigger events on every key press.
params: dict: Keyword arguments to be passed to the widget constructor

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.input.TimePicker(**params: Any)[source]#

Bases: _TimeCommon

The TimePicker allows selecting a time value using a text box and a time-picking utility.

Reference: https://panel.holoviz.org/reference/widgets/TimePicker.html

Example:

>>> TimePicker(
...     value="12:59:31", start="09:00:00", end="18:00:00", name="Time"
... )

Parameters inherited from:

value = param.ClassSelector(allow_None=True, allow_refs=False, class_=(<class ‘datetime.time’>, <class ‘str’>), label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1716e7690>): The current value
start = param.ClassSelector(allow_None=True, allow_refs=False, class_=(<class ‘datetime.time’>, <class ‘str’>), label=’Start’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17158d8d0>): Inclusive lower bound of the allowed time selection
end = param.ClassSelector(allow_None=True, allow_refs=False, class_=(<class ‘datetime.time’>, <class ‘str’>), label=’End’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1716e7750>): Inclusive upper bound of the allowed time selection
format = param.String(allow_refs=False, default=’H:i’, label=’Format’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17158ca50>): Formatting specification for the display of the picked date. +—+————————————+————+ | H | Hours (24 hours) | 00 to 23 | | h | Hours | 1 to 12 | | G | Hours, 2 digits with leading zeros | 1 to 12 | | i | Minutes | 00 to 59 | | S | Seconds, 2 digits | 00 to 59 | | s | Seconds | 0, 1 to 59 | | K | AM/PM | AM or PM | +—+————————————+————+ See also https://flatpickr.js.org/formatting/#date-formatting-tokens.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

`misc` Module#

Miscellaneous widgets which do not fit into the other main categories.

class panel.widgets.misc.FileDownload(file=None, **params)[source]#

Bases: IconMixin

The FileDownload widget allows a user to download a file.

It works either by sending the file data to the browser on initialization (`embed`=True), or when the button is clicked.

Reference: https://panel.holoviz.org/reference/widgets/FileDownload.html

Example:

>>> FileDownload(file='IntroductionToPanel.ipynb', filename='intro.ipynb')

Parameters inherited from:

auto = param.Boolean(allow_refs=False, default=True, label=’Auto’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1781bb4d0>): Whether to download on the initial click or allow for right-click save as.
button_type = param.ObjectSelector(allow_refs=False, default=’default’, label=’Button type’, names={}, nested_refs=False, objects=[‘default’, ‘primary’, ‘success’, ‘warning’, ‘danger’, ‘light’], rx=<param.reactive.reactive_ops object at 0x1781bd150>): A button theme; should be one of ‘default’ (white), ‘primary’ (blue), ‘success’ (green), ‘info’ (yellow), ‘light’ (light), or ‘danger’ (red).
button_style = param.ObjectSelector(allow_refs=False, default=’solid’, label=’Button style’, names={}, nested_refs=False, objects=[‘solid’, ‘outline’], rx=<param.reactive.reactive_ops object at 0x1781bd510>): A button style to switch between ‘solid’, ‘outline’.
callback = param.Callable(allow_None=True, allow_refs=False, label=’Callback’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1777e8890>): A callable that returns the file path or file-like object.
data = param.String(allow_None=True, allow_refs=False, label=’Data’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x177db2d50>): The data being transferred.
embed = param.Boolean(allow_refs=False, default=False, label=’Embed’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x177f7d390>): Whether to embed the file on initialization.
file = param.Parameter(allow_None=True, allow_refs=False, label=’File’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x177a56c10>): The file, Path, file-like object or file contents to transfer. If the file is not pointing to a file on disk a filename must also be provided.
filename = param.String(allow_None=True, allow_refs=False, label=’Filename’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17755ad90>): A filename which will also be the default name when downloading the file.
label = param.String(allow_refs=False, default=’Download file’, label=’Label’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x177139710>): The label of the download button
description = param.String(allow_None=True, allow_refs=False, label=’Description’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17755ad90>): An HTML string describing the function of this component.

_clicks = param.Integer(allow_refs=False, default=0, inclusive_bounds=(True, True), label=’ clicks’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x177f7d390>)

_transfers = param.Integer(allow_refs=False, default=0, inclusive_bounds=(True, True), label=’ transfers’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1781bd510>)

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.misc.JSONEditor(**params: Any)[source]#

Bases: Widget

The JSONEditor provides a visual editor for JSON-serializable datastructures, e.g. Python dictionaries and lists, with functionality for different editing modes, inserting objects and validation using JSON Schema.

Reference: https://panel.holoviz.org/reference/widgets/JSONEditor.html

Example:

>>> JSONEditor(value={
...     'dict'  : {'key': 'value'},
...     'float' : 3.14,
...     'int'   : 1,
...     'list'  : [1, 2, 3],
...     'string': 'A string',
... }, mode='code')

Parameters inherited from:

value = param.Parameter(allow_refs=False, default={}, label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1781f7f10>): JSON data to be edited.
menu = param.Boolean(allow_refs=False, default=True, label=’Menu’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1781f1650>): Adds main menu bar - Contains format, sort, transform, search etc. functionality. true by default. Applicable in all types of mode.
mode = param.Selector(allow_refs=False, default=’tree’, label=’Mode’, names={}, nested_refs=False, objects=[‘tree’, ‘view’, ‘form’, ‘text’, ‘preview’], rx=<param.reactive.reactive_ops object at 0x1781f1850>): Sets the editor mode. In ‘view’ mode, the data and datastructure is read-only. In ‘form’ mode, only the value can be changed, the data structure is read-only. Mode ‘code’ requires the Ace editor to be loaded on the page. Mode ‘text’ shows the data as plain text. The ‘preview’ mode can handle large JSON documents up to 500 MiB. It shows a preview of the data, and allows to transform, sort, filter, format, or compact the data.
search = param.Boolean(allow_refs=False, default=True, label=’Search’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1781f1590>): Enables a search box in the upper right corner of the JSONEditor. true by default. Only applicable when mode is ‘tree’, ‘view’, or ‘form’.
selection = param.List(allow_refs=False, bounds=(0, None), default=[], label=’Selection’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1781f7a50>): Current selection.
schema = param.Dict(allow_None=True, allow_refs=False, class_=<class ‘dict’>, label=’Schema’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x177acb850>): Validate the JSON object against a JSON schema. A JSON schema describes the structure that a JSON object must have, like required properties or the type that a value must have. See http://json-schema.org/ for more information.
templates = param.List(allow_refs=False, bounds=(0, None), default=[], label=’Templates’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1781f7bd0>): Array of templates that will appear in the context menu, Each template is a json object precreated that can be added as a object value to any node in your document.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.misc.VideoStream(**params: Any)[source]#

Bases: Widget

The VideoStream displays a video from a local stream (for example from a webcam) and allows accessing the streamed video data from Python.

Reference: https://panel.holoviz.org/reference/widgets/VideoStream.html

Example:

>>> VideoStream(name='Video Stream', timeout=100)

Parameters inherited from:

value = param.String(allow_refs=False, default=’’, label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17816b550>): A base64 representation of the video stream snapshot.
format = param.ObjectSelector(allow_refs=False, default=’png’, label=’Format’, names={}, nested_refs=False, objects=[‘png’, ‘jpeg’], rx=<param.reactive.reactive_ops object at 0x1780e0350>): The file format as which the video is returned.
paused = param.Boolean(allow_refs=False, default=False, label=’Paused’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17816b950>): Whether the video is currently paused
timeout = param.Number(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’Timeout’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17810dad0>): Interval between snapshots in millisecons

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

snapshot()[source]#: Triggers a snapshot of the current VideoStream state to sync the widget value.

`player` Module#

Defines Player widgets which offer media-player like controls.

class panel.widgets.player.DiscretePlayer(*, value_throttled, direction, interval, loop_policy, preview_duration, scale_buttons, show_loop_controls, show_value, step, value_align, visible_buttons, visible_loop_options, options, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: PlayerBase, SelectBase

The DiscretePlayer provides controls to iterate through a list of discrete options. The speed at which the widget plays is defined by the interval (in milliseconds), but it is also possible to skip items using the step parameter.

Reference: https://panel.holoviz.org/reference/widgets/DiscretePlayer.html

Example:

>>> DiscretePlayer(
...     name='Discrete Player',
...     options=[2, 4, 8, 16, 32, 64, 128], value=32,
...     loop_policy='loop',
...     value_align='start'
... )

Parameters inherited from:

value = param.Parameter(allow_None=True, allow_refs=False, label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17880c4d0>): Current player value
interval = param.Integer(allow_refs=False, default=500, inclusive_bounds=(True, True), label=’Interval’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17880ebd0>): Interval between updates
show_value = param.Boolean(allow_refs=False, default=True, label=’Show value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x178225690>): Whether to show the widget value
value_throttled = param.Parameter(allow_None=True, allow_refs=False, constant=True, label=’Value throttled’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17880da90>): Current player value

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.player.Player(*, end, start, value_throttled, direction, interval, loop_policy, preview_duration, scale_buttons, show_loop_controls, show_value, step, value_align, visible_buttons, visible_loop_options, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: PlayerBase

The Player provides controls to play and skip through a number of frames defined by explicit start and end values. The speed at which the widget plays is defined by the interval (in milliseconds), but it is also possible to skip frames using the step parameter.

Reference: https://panel.holoviz.org/reference/widgets/Player.html

Example:

>>> Player(name='Player', start=0, end=100, value=32, loop_policy='loop', value_align='top_center')

Parameters inherited from:

value = param.Integer(allow_refs=False, default=0, inclusive_bounds=(True, True), label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1788203d0>): Current player value
start = param.Integer(allow_refs=False, default=0, inclusive_bounds=(True, True), label=’Start’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1788221d0>): Lower bound on the slider value
end = param.Integer(allow_refs=False, default=10, inclusive_bounds=(True, True), label=’End’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x178820310>): Upper bound on the slider value
value_throttled = param.Integer(allow_refs=False, constant=True, default=0, inclusive_bounds=(True, True), label=’Value throttled’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x178822110>): Current throttled player value.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.player.PlayerBase(*, direction, interval, loop_policy, preview_duration, scale_buttons, show_loop_controls, show_value, step, value_align, visible_buttons, visible_loop_options, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: Widget

Parameters inherited from:

height = param.Integer(allow_refs=False, bounds=(0, None), default=80, inclusive_bounds=(True, True), label=’Height’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17884bf50>): The height of the component (in pixels). This can be either fixed or preferred height, depending on height sizing policy.
width = param.Integer(allow_None=True, allow_refs=False, bounds=(0, None), default=510, inclusive_bounds=(True, True), label=’Width’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17883d610>): Width of this component. If sizing_mode is set to stretch or scale mode this will merely be used as a suggestion.
direction = param.Integer(allow_refs=False, default=0, inclusive_bounds=(True, True), label=’Direction’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17883e590>): Current play direction of the Player (-1: playing in reverse, 0: paused, 1: playing)
interval = param.Integer(allow_refs=False, default=500, inclusive_bounds=(True, True), label=’Interval’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1787fe690>): Interval between updates, in milliseconds. Default is 500, i.e. two updates per second.
loop_policy = param.ObjectSelector(allow_refs=False, default=’once’, label=’Loop policy’, names={}, nested_refs=False, objects=[‘once’, ‘loop’, ‘reflect’], rx=<param.reactive.reactive_ops object at 0x17884b690>): Policy used when player hits last frame
preview_duration = param.Integer(allow_refs=False, bounds=(0, None), default=1500, inclusive_bounds=(True, True), label=’Preview duration’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17882d910>): Duration (in milliseconds) for showing the current FPS when clicking the slower/faster buttons, before reverting to the icon.
show_loop_controls = param.Boolean(allow_refs=False, default=True, label=’Show loop controls’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17884b450>): Whether the loop controls radio buttons are shown
show_value = param.Boolean(allow_refs=False, default=False, label=’Show value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17882e2d0>): Whether to show the widget value
step = param.Integer(allow_refs=False, default=1, inclusive_bounds=(True, True), label=’Step’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x178848f10>): Number of frames to step forward and back by on each event.
value_align = param.ObjectSelector(allow_refs=False, label=’Value align’, names={}, nested_refs=False, objects=[‘start’, ‘center’, ‘end’], rx=<param.reactive.reactive_ops object at 0x17882dd10>): Location to display the value of the slider (“start”, “center”, “end”)
scale_buttons = param.Number(allow_refs=False, default=1, inclusive_bounds=(True, True), label=’Scale buttons’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17860bcd0>): The scaling factor to resize the buttons.
visible_buttons = param.List(allow_refs=False, bounds=(0, None), default=[‘slower’, ‘first’, ‘previous’, ‘reverse’, ‘pause’, ‘play’, ‘next’, ‘last’, ‘faster’], label=’Visible buttons’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17882efd0>): The buttons to display on the player.
visible_loop_options = param.List(allow_refs=False, bounds=(0, None), default=[‘once’, ‘loop’, ‘reflect’], label=’Visible loop options’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17884ae90>): The loop options to display on the player.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

`select` Module#

Defines various Select widgets which allow choosing one or more items from a list of options.

class panel.widgets.select.AutocompleteInput(*, case_sensitive, description, min_characters, placeholder, restrict, search_strategy, value_input, options, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: SingleSelectBase

The AutocompleteInput widget allows selecting multiple values from a list of options.

It falls into the broad category of multi-value, option-selection widgets that provide a compatible API and include the MultiSelect, CrossSelector, CheckBoxGroup and CheckButtonGroup widgets.

The MultiChoice widget provides a much more compact UI than MultiSelect.

Reference: https://panel.holoviz.org/reference/widgets/AutocompleteInput.html

Example:

>>> AutocompleteInput(
...     name='Study', options=['Biology', 'Chemistry', 'Physics'],
...     placeholder='Write your study here ...'
... )

Parameters inherited from:

value = param.Parameter(allow_None=True, allow_refs=False, default=’’, label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x178d4e890>): Initial or entered text value updated when <enter> key is pressed.
width = param.Integer(allow_None=True, allow_refs=False, bounds=(0, None), default=300, inclusive_bounds=(True, True), label=’Width’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x178d45410>): Width of this component. If sizing_mode is set to stretch or scale mode this will merely be used as a suggestion.
case_sensitive = param.Boolean(allow_refs=False, default=True, label=’Case sensitive’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x178be45d0>): Enable or disable case sensitivity.
min_characters = param.Integer(allow_refs=False, default=2, inclusive_bounds=(True, True), label=’Min characters’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x178d44b50>): The number of characters a user must type before completions are presented.
placeholder = param.String(allow_refs=False, default=’’, label=’Placeholder’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x178d4ef90>): Placeholder for empty input field.
restrict = param.Boolean(allow_refs=False, default=True, label=’Restrict’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x178d4c110>): Set to False in order to allow users to enter text that is not present in the list of completion strings.
search_strategy = param.Selector(allow_refs=False, default=’starts_with’, label=’Search strategy’, names={}, nested_refs=False, objects=[‘starts_with’, ‘includes’], rx=<param.reactive.reactive_ops object at 0x178c86b50>): Define how to search the list of completion strings. The default option “starts_with” means that the user’s text must match the start of a completion string. Using “includes” means that the user’s text can match any substring of a completion string.
value_input = param.String(allow_None=True, allow_refs=False, default=’’, label=’Value input’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x178d4c110>): Initial or entered text value updated on every key press.
description = param.String(allow_None=True, allow_refs=False, label=’Description’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x178d4f390>): An HTML string describing the function of this component.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.select.CheckBoxGroup(*, inline, options, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: _CheckGroupBase

The CheckBoxGroup widget allows selecting between a list of options by ticking the corresponding checkboxes.

It falls into the broad category of multi-option selection widgets that provide a compatible API and include the MultiSelect, CrossSelector and CheckButtonGroup widgets.

Reference: https://panel.holoviz.org/reference/widgets/CheckBoxGroup.html

Example:

>>> CheckBoxGroup(
...     name='Fruits', value=['Apple', 'Pear'], options=['Apple', 'Banana', 'Pear', 'Strawberry'],
...     inline=True
... )

Parameters inherited from:

inline = param.Boolean(allow_refs=False, default=False, label=’Inline’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x178d72790>): Whether the items be arrange vertically (False) or horizontally in-line (True).

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.select.CheckButtonGroup(*, orientation, options, button_style, button_type, description, description_delay, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: _CheckGroupBase, _ButtonBase, TooltipMixin

The CheckButtonGroup widget allows selecting between a list of options by toggling the corresponding buttons.

It falls into the broad category of multi-option selection widgets that provide a compatible API and include the MultiSelect, CrossSelector and CheckBoxGroup widgets.

Reference: https://panel.holoviz.org/reference/widgets/CheckButtonGroup.html

Example:

>>> CheckButtonGroup(
...     name='Regression Models', value=['Lasso', 'Ridge'],
...     options=['Lasso', 'Linear', 'Ridge', 'Polynomial']
... )

Parameters inherited from:

orientation = param.Selector(allow_refs=False, default=’horizontal’, label=’Orientation’, names={}, nested_refs=False, objects=[‘horizontal’, ‘vertical’], rx=<param.reactive.reactive_ops object at 0x178d83850>): Button group orientation, either ‘horizontal’ (default) or ‘vertical’.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.select.ColorMap(*, ncols, swatch_height, swatch_width, value_name, options, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: SingleSelectBase

The ColorMap widget allows selecting a value from a dictionary of options each containing a colormap specified as a list of colors or a matplotlib colormap.

Reference: https://panel.holoviz.org/reference/widgets/ColorMap.html

Example:

>>> ColorMap(name='Reds', options={'Reds': ['white', 'red'], 'Blues': ['#ffffff', '#0000ff']})

Parameters inherited from:

value = param.Parameter(allow_None=True, allow_refs=False, label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x178c6b4d0>): The selected colormap.
options = param.Dict(allow_refs=False, class_=<class ‘dict’>, default={}, label=’Options’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x178ce97d0>): Dictionary of colormaps
ncols = param.Integer(allow_refs=False, default=1, inclusive_bounds=(True, True), label=’Ncols’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x178d0a490>): Number of columns of swatches to display.
swatch_height = param.Integer(allow_refs=False, default=20, inclusive_bounds=(True, True), label=’Swatch height’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x178da0550>): Height of the color swatches.
swatch_width = param.Integer(allow_refs=False, default=100, inclusive_bounds=(True, True), label=’Swatch width’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x178cb1a10>): Width of the color swatches.
value_name = param.String(allow_None=True, allow_refs=False, label=’Value name’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x178d8cbd0>): Name of the selected colormap.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.select.CrossSelector(*, definition_order, filter_fn, size, description, options, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: CompositeWidget, MultiSelect

A composite widget which allows selecting from a list of items by moving them between two lists. Supports filtering values by name to select them in bulk.

Reference: https://panel.holoviz.org/reference/widgets/CrossSelector.html

Example:

>>> CrossSelector(
...     name='Fruits', value=['Apple', 'Pear'],
...     options=['Apple', 'Banana', 'Pear', 'Strawberry']
... )

Parameters inherited from:

height = param.Integer(allow_None=True, allow_refs=False, bounds=(0, None), default=200, inclusive_bounds=(True, True), label=’Height’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x178d9c790>): The number of options shown at once (note this is the only way to control the height of this widget)
width = param.Integer(allow_None=True, allow_refs=False, bounds=(0, None), default=600, inclusive_bounds=(True, True), label=’Width’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x178dac4d0>): The number of options shown at once (note this is the only way to control the height of this widget)
size = param.Integer(allow_refs=False, default=10, inclusive_bounds=(True, True), label=’Size’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x178dba390>): The number of options shown at once (note this is the only way to control the height of this widget)
filter_fn = param.Callable(allow_refs=False, label=’Filter fn’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x1789e0890>): The filter function applied when querying using the text fields, defaults to re.search. Function is two arguments, the query or pattern and the item label.
definition_order = param.Integer(allow_refs=False, default=True, inclusive_bounds=(True, True), label=’Definition order’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x178dba210>): Whether to preserve definition order after filtering. Disable to allow the order of selection to define the order of the selected list.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

filter_fn(string, flags=0)[source]#: Scan through string looking for a match to the pattern, returning a Match object, or None if no match was found.

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

on_double_click(callback: Callable[[Event], None | Awaitable[None]]) → Watcher[source]#

Register a callback to be executed when a MultiSelect option is double-clicked.

The callback is given an DoubleClickEvent argument

Example#

>>> select = pn.widgets.MultiSelect(options=["A", "B", "C"])
>>> def handle_click(event):
...    print(f"Option {event.option} was double clicked.")
>>> select.on_double_click(handle_click)

Arguments#

callback:: The function to run on click events. Must accept a positional Event argument. Can be a sync or async function

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.select.MultiChoice(*, delete_button, max_items, option_limit, placeholder, search_option_limit, solid, description, options, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: _MultiSelectBase

The MultiChoice widget allows selecting multiple values from a list of options.

It falls into the broad category of multi-value, option-selection widgets that provide a compatible API and include the MultiSelect, CrossSelector, CheckBoxGroup and CheckButtonGroup widgets.

The MultiChoice widget provides a much more compact UI than MultiSelect.

Reference: https://panel.holoviz.org/reference/widgets/MultiChoice.html

Example:

>>> MultiChoice(
...     name='Favourites', value=['Panel', 'hvPlot'],
...     options=['Panel', 'hvPlot', 'HoloViews', 'GeoViews', 'Datashader', 'Param', 'Colorcet'],
...     max_items=2
... )

Parameters inherited from:

width = param.Integer(allow_None=True, allow_refs=False, bounds=(0, None), default=300, inclusive_bounds=(True, True), label=’Width’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x178dcfa90>): Width of this component. If sizing_mode is set to stretch or scale mode this will merely be used as a suggestion.
delete_button = param.Boolean(allow_refs=False, default=True, label=’Delete button’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x178dd53d0>): Whether to display a button to delete a selected option.
max_items = param.Integer(allow_None=True, allow_refs=False, bounds=(1, None), inclusive_bounds=(True, True), label=’Max items’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x178dcf9d0>): Maximum number of options that can be selected.
option_limit = param.Integer(allow_None=True, allow_refs=False, bounds=(1, None), inclusive_bounds=(True, True), label=’Option limit’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x178dcd190>): Maximum number of options to display at once.
search_option_limit = param.Integer(allow_None=True, allow_refs=False, bounds=(1, None), inclusive_bounds=(True, True), label=’Search option limit’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x178dcf9d0>): Maximum number of options to display at once if search string is entered.
placeholder = param.String(allow_refs=False, default=’’, label=’Placeholder’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x178dc8050>): String displayed when no selection has been made.
solid = param.Boolean(allow_refs=False, default=True, label=’Solid’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x178dcf1d0>): Whether to display widget with solid or light style.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.select.MultiSelect(*, size, description, options, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: _MultiSelectBase

The MultiSelect widget allows selecting multiple values from a list of options.

It falls into the broad category of multi-value, option-selection widgets that provide a compatible API and include the`CrossSelector`, CheckBoxGroup and CheckButtonGroup widgets.

Reference: https://panel.holoviz.org/reference/widgets/MultiSelect.html

Example:

>>> MultiSelect(
...     name='Frameworks', value=['Bokeh', 'Panel'],
...     options=['Bokeh', 'Dash', 'Panel', 'Streamlit', 'Voila'], size=8
... )

Parameters inherited from:

size = param.Integer(allow_refs=True, default=4, inclusive_bounds=(True, True), label=’Size’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x178df19d0>): The number of items displayed at once (i.e. determines the widget height).

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

on_double_click(callback: Callable[[Event], None | Awaitable[None]]) → Watcher[source]#

Register a callback to be executed when a MultiSelect option is double-clicked.

The callback is given an DoubleClickEvent argument

Example#

>>> select = pn.widgets.MultiSelect(options=["A", "B", "C"])
>>> def handle_click(event):
...    print(f"Option {event.option} was double clicked.")
>>> select.on_double_click(handle_click)

Arguments#

callback:: The function to run on click events. Must accept a positional Event argument. Can be a sync or async function

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.select.NestedSelect(*, _levels, _max_depth, _widgets, layout, levels, options, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: CompositeWidget

The NestedSelect widget is composed of multiple widgets, where subsequent select options depend on the parent’s value.

Reference: https://panel.holoviz.org/reference/widgets/NestedSelect.html

Example:

>>> NestedSelect(
...     options={
...         "gfs": {"tmp": [1000, 500], "pcp": [1000]},
...         "name": {"tmp": [1000, 925, 850, 700, 500], "pcp": [1000]},
...     },
...     levels=["model", "var", "level"],
... )

Parameters inherited from:

value = param.Dict(allow_None=True, allow_refs=False, class_=<class ‘dict’>, label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x178e0d0d0>): The value from all the Select widgets; the keys are the levels names. If no levels names are specified, the keys are the levels indices.
disabled = param.Boolean(allow_refs=False, default=False, label=’Disabled’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x178e0e810>): Whether the widget is disabled.
options = param.ClassSelector(allow_None=True, allow_refs=False, class_=(<class ‘dict’>, <class ‘function’>), label=’Options’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x178858690>): The options to select from. The options may be nested dictionaries, lists, or callables that return those types. If callables are used, the callables must accept level and value keyword arguments, where level is the level that updated and value is a dictionary of the current values, containing keys up to the level that was updated.
layout = param.Parameter(allow_refs=False, default=<class ‘panel.layout.base.Column’>, label=’Layout’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x178e0e750>): The layout type of the widgets. If a dictionary, a “type” key can be provided, to specify the layout type of the widgets, and any additional keyword arguments will be used to instantiate the layout.
levels = param.List(allow_refs=False, bounds=(0, None), default=[], label=’Levels’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x178e0c6d0>): Either a list of strings or a list of dictionaries. If a list of strings, the strings are used as the names of the levels. If a list of dictionaries, each dictionary may have a “name” key, which is used as the name of the level, a “type” key, which is used as the type of widget, and any corresponding widget keyword arguments. Must be specified if options is callable.
_widgets = param.List(allow_refs=False, bounds=(0, None), default=[], label=’ widgets’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x178e0e910>): The nested select widgets.
_max_depth = param.Integer(allow_refs=False, default=0, inclusive_bounds=(True, True), label=’ max depth’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x178e0ea50>): The number of levels of the nested select widgets.
_levels = param.List(allow_refs=False, bounds=(0, None), default=[], label=’ levels’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x178e0ca90>): The internal rep of levels to prevent overwriting user provided levels.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

layout[source]#: alias of Column

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.select.RadioBoxGroup(*, inline, options, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: _RadioGroupBase

The RadioBoxGroup widget allows selecting from a list or dictionary of values using a set of checkboxes.

It falls into the broad category of single-value, option-selection widgets that provide a compatible API and include the RadioButtonGroup, Select and DiscreteSlider widgets.

Reference: https://panel.holoviz.org/reference/widgets/RadioBoxGroup.html

Example:

>>> RadioBoxGroup(
...     name='Sponsor', options=['Anaconda', 'Blackstone'], inline=True
... )

Parameters inherited from:

inline = param.Boolean(allow_refs=False, default=False, label=’Inline’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x178e3d590>): Whether the items be arrange vertically (False) or horizontally in-line (True).

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.select.RadioButtonGroup(*, orientation, options, button_style, button_type, description, description_delay, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: _RadioGroupBase, _ButtonBase, TooltipMixin

The RadioButtonGroup widget allows selecting from a list or dictionary of values using a set of toggle buttons.

It falls into the broad category of single-value, option-selection widgets that provide a compatible API and include the RadioBoxGroup, Select, and DiscreteSlider widgets.

Reference: https://panel.holoviz.org/reference/widgets/RadioButtonGroup.html

Example:

>>> RadioButtonGroup(
...     name='Plotting library', options=['Matplotlib', 'Bokeh', 'Plotly'],
...     button_type='success'
... )

Parameters inherited from:

orientation = param.Selector(allow_refs=False, default=’horizontal’, label=’Orientation’, names={}, nested_refs=False, objects=[‘horizontal’, ‘vertical’], rx=<param.reactive.reactive_ops object at 0x178e579d0>): Button group orientation, either ‘horizontal’ (default) or ‘vertical’.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.select.Select(*, description, disabled_options, groups, size, options, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: SingleSelectBase

The Select widget allows selecting a value from a list or dictionary of options by selecting it from a dropdown menu or selection area.

It falls into the broad category of single-value, option-selection widgets that provide a compatible API and include the RadioBoxGroup, AutocompleteInput and DiscreteSlider widgets.

Reference: https://panel.holoviz.org/reference/widgets/Select.html

Example:

>>> Select(name='Study', options=['Biology', 'Chemistry', 'Physics'])

Parameters inherited from:

width = param.Integer(allow_None=True, allow_refs=False, bounds=(0, None), default=300, inclusive_bounds=(True, True), label=’Width’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x178e77910>): Width of this component. If sizing_mode is set to stretch or scale mode this will merely be used as a suggestion.
description = param.String(allow_None=True, allow_refs=False, label=’Description’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x178e79310>): An HTML string describing the function of this component.
disabled_options = param.List(allow_refs=False, bounds=(0, None), default=[], label=’Disabled options’, nested_refs=True, rx=<param.reactive.reactive_ops object at 0x178e76fd0>): Optional list of options that are disabled, i.e. unusable and un-clickable. If options is a dictionary the list items must be dictionary values.
groups = param.Dict(allow_None=True, allow_refs=False, class_=<class ‘dict’>, label=’Groups’, nested_refs=True, rx=<param.reactive.reactive_ops object at 0x178e789d0>): Dictionary whose keys are used to visually group the options and whose values are either a list or a dictionary of options to select from. Mutually exclusive with options and valid only if size is 1.
size = param.Integer(allow_refs=False, bounds=(1, None), default=1, inclusive_bounds=(True, True), label=’Size’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x178e74ed0>): Declares how many options are displayed at the same time. If set to 1 displays options as dropdown otherwise displays scrollable area.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.select.SelectBase(**params: Any)[source]#

Bases: Widget

Parameters inherited from:

options = param.ClassSelector(allow_refs=True, class_=(<class ‘dict’>, <class ‘list’>), default=[], label=’Options’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x178e99e10>)

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.select.SingleSelectBase(*, options, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: SelectBase

Parameters inherited from:

value = param.Parameter(allow_None=True, allow_refs=False, label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x178ea8dd0>): The widget value which the widget type resolves to when used as a reactive param reference.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.select.ToggleGroup(*, options, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: SingleSelectBase

This class is a factory of ToggleGroup widgets.

A ToggleGroup is a group of widgets which can be switched ‘on’ or ‘off’.

Two types of widgets are available through the widget_type argument :

‘button’ (default)
‘box’

Two different behaviors are available through behavior argument:

‘check’ (default)boolean
Any number of widgets can be selected. In this case value is a ‘list’ of objects.
‘radio’boolean
One and only one widget is switched on. In this case value is an ‘object’.

Parameters inherited from:

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

`slider` Module#

Sliders allow you to select a value from a defined range of values by moving one or more handle(s).

The value will update when a handle is dragged.
The `value_throttled`will update when a handle is released.

class panel.widgets.slider.ContinuousSlider(*, format, bar_color, direction, orientation, show_value, tooltips, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: _SliderBase

Parameters inherited from:

format = param.ClassSelector(allow_None=True, allow_refs=False, class_=(<class ‘str’>, <class ‘bokeh.models.formatters.TickFormatter’>), label=’Format’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17a589750>): A custom format string or Bokeh TickFormatter.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.slider.DateRangeSlider(*, end, format, start, step, value_throttled, bar_color, direction, orientation, show_value, tooltips, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: _SliderBase

The DateRangeSlider widget allows selecting a date range using a slider with two handles. Supports datetime.datetime, datetime.date and np.datetime64 ranges.

Reference: https://panel.holoviz.org/reference/widgets/DateRangeSlider.html

Example:

>>> import datetime as dt
>>> DateRangeSlider(
...     value=(dt.datetime(2025, 1, 9), dt.datetime(2025, 1, 16)),
...     start=dt.datetime(2025, 1, 1),
...     end=dt.datetime(2025, 1, 31),
...     step=2,
...     name="A tuple of datetimes"
... )

Parameters inherited from:

value = param.DateRange(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’Value’, length=2, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17a5aff10>): The selected range as a tuple of values. Updated when one of the handles is dragged. Supports datetime.datetime, datetime.date, and np.datetime64 ranges.
value_start = param.Date(allow_None=True, allow_refs=False, constant=True, inclusive_bounds=(True, True), label=’Value start’, nested_refs=False, readonly=True, rx=<param.reactive.reactive_ops object at 0x17a59db50>): The lower value of the selected range.
value_end = param.Date(allow_None=True, allow_refs=False, constant=True, inclusive_bounds=(True, True), label=’Value end’, nested_refs=False, readonly=True, rx=<param.reactive.reactive_ops object at 0x17a5aff90>): The upper value of the selected range.
value_throttled = param.DateRange(allow_None=True, allow_refs=False, constant=True, inclusive_bounds=(True, True), label=’Value throttled’, length=2, nested_refs=True, rx=<param.reactive.reactive_ops object at 0x17a596210>): The selected range as a tuple of values. Updated one of the handles is released. Supports datetime.datetime, datetime.date and np.datetime64 ranges
start = param.Date(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’Start’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17a5ae490>): The lower bound.
end = param.Date(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’End’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17a595690>): The upper bound.
step = param.Number(allow_refs=False, default=1, inclusive_bounds=(True, True), label=’Step’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17a5afb10>): The step size in days. Default is 1 day.
format = param.String(allow_None=True, allow_refs=False, label=’Format’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17a5acfd0>): Datetime format used for parsing and formatting the date.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.slider.DateSlider(*, as_datetime, end, format, start, step, value_throttled, bar_color, direction, orientation, show_value, tooltips, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: _SliderBase

The DateSlider widget allows selecting a value within a set of bounds using a slider. Supports datetime.datetime, datetime.date and np.datetime64 values. The step size is fixed at 1 day.

Reference: https://panel.holoviz.org/reference/widgets/DateSlider.html

Example:

>>> import datetime as dt
>>> DateSlider(
...     value=dt.datetime(2025, 1, 1),
...     start=dt.datetime(2025, 1, 1),
...     end=dt.datetime(2025, 1, 7),
...     name="A datetime value"
... )

Parameters inherited from:

value = param.Date(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17a5d2a10>): The selected date value of the slider. Updated when the slider handle is dragged. Supports datetime.datetime, datetime.date or np.datetime64 types.
value_throttled = param.Date(allow_None=True, allow_refs=False, constant=True, inclusive_bounds=(True, True), label=’Value throttled’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17a5c8850>): The value of the slider. Updated when the slider handle is released.
start = param.Date(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’Start’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17a5d2950>): The lower bound.
end = param.Date(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’End’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17a5c87d0>): The upper bound.
as_datetime = param.Boolean(allow_refs=False, default=False, label=’As datetime’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17a5d2050>): Whether to store the date as a datetime.
step = param.Integer(allow_refs=False, bounds=(1, None), default=1, inclusive_bounds=(True, True), label=’Step’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17a5d26d0>): The step parameter in days.
format = param.String(allow_None=True, allow_refs=False, label=’Format’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17a5d2050>): Datetime format used for parsing and formatting the date.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.slider.DatetimeRangeSlider(*, end, format, start, step, value_throttled, bar_color, direction, orientation, show_value, tooltips, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: DateRangeSlider

The DatetimeRangeSlider widget allows selecting a datetime range using a slider with two handles. Supports datetime.datetime and np.datetime64 ranges.

Reference: https://panel.holoviz.org/reference/widgets/DatetimeRangeSlider.html

Example:

>>> import datetime as dt
>>> DatetimeRangeSlider(
...     value=(dt.datetime(2025, 1, 9), dt.datetime(2025, 1, 16)),
...     start=dt.datetime(2025, 1, 1),
...     end=dt.datetime(2025, 1, 31),
...     step=10000,
...     name="A tuple of datetimes"
... )

Parameters inherited from:

step = param.Number(allow_refs=False, default=60000, inclusive_bounds=(True, True), label=’Step’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17a5f6310>): The step size in ms. Default is 1 min.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.slider.DiscreteSlider(*, formatter, options, value_throttled, bar_color, direction, orientation, show_value, tooltips, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: CompositeWidget, _SliderBase

The DiscreteSlider widget allows selecting a value from a discrete list or dictionary of values using a slider.

Reference: https://panel.holoviz.org/reference/widgets/DiscreteSlider.html

Example:

>>> DiscreteSlider(
...     value=0,
...     options=list([0, 1, 2, 4, 8, 16, 32, 64]),
...     name="A discrete value",
... )

Parameters inherited from:

value = param.Parameter(allow_None=True, allow_refs=False, label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17a60cad0>): The selected value of the slider. Updated when the handle is dragged. Must be one of the options.
value_throttled = param.Parameter(allow_None=True, allow_refs=False, constant=True, label=’Value throttled’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17a60e210>): The value of the slider. Updated when the handle is released.
options = param.ClassSelector(allow_refs=False, class_=(<class ‘dict’>, <class ‘list’>), default=[], label=’Options’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17a60c7d0>): A list or dictionary of valid options.
formatter = param.String(allow_refs=False, default=’%.3g’, label=’Formatter’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17a60e210>): A custom format string. Separate from format parameter since formatting is applied in Python, not via the bokeh TickFormatter.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

property labels#: The list of labels to display

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

property values#: The list of option values

class panel.widgets.slider.EditableFloatSlider(*, fixed_end, fixed_start, editable, end, start, step, value_throttled, format, bar_color, direction, orientation, show_value, tooltips, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: _EditableContinuousSlider, FloatSlider

The EditableFloatSlider widget allows selecting selecting a numeric floating-point value within a set of bounds using a slider and for more precise control offers an editable number input box.

Reference: https://panel.holoviz.org/reference/widgets/EditableFloatSlider.html

Example:

>>> EditableFloatSlider(
...     value=1.0, start=0.0, end=2.0, step=0.25, name="A float value"
... )

Parameters inherited from:

fixed_start = param.Number(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’Fixed start’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17a628650>): A fixed lower bound for the slider and input.
fixed_end = param.Number(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’Fixed end’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17a62a450>): A fixed upper bound for the slider and input.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.slider.EditableIntSlider(*, fixed_end, fixed_start, editable, end, start, step, value_throttled, format, bar_color, direction, orientation, show_value, tooltips, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: _EditableContinuousSlider, IntSlider

The EditableIntSlider widget allows selecting selecting an integer value within a set of bounds using a slider and for more precise control offers an editable integer input box.

Reference: https://panel.holoviz.org/reference/widgets/EditableIntSlider.html

Example:

>>> EditableIntSlider(
...     value=2, start=0, end=5, step=1, name="An integer value"
... )

Parameters inherited from:

fixed_start = param.Integer(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’Fixed start’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17a63ab50>): A fixed lower bound for the slider and input.
fixed_end = param.Integer(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’Fixed end’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17a62c990>): A fixed upper bound for the slider and input.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.slider.EditableRangeSlider(*, editable, end, fixed_end, fixed_start, format, start, step, value_throttled, bar_color, direction, orientation, show_value, tooltips, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: CompositeWidget, _SliderBase

The EditableRangeSlider widget allows selecting a floating-point range using a slider with two handles and for more precise control also offers a set of number input boxes.

Reference: https://panel.holoviz.org/reference/widgets/EditableRangeSlider.html

Example:

>>> EditableRangeSlider(
...      value=(1.0, 1.5), start=0.0, end=2.0, step=0.25, name="A tuple of floats"
... )

Parameters inherited from:

value = param.Range(allow_refs=False, default=(0, 1), inclusive_bounds=(True, True), label=’Value’, length=2, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17a661fd0>): Current range value. Updated when a handle is dragged.
show_value = param.Boolean(allow_refs=False, constant=True, default=False, label=’Show value’, nested_refs=False, readonly=True, rx=<param.reactive.reactive_ops object at 0x17a6636d0>): Whether to show the widget value.
value_throttled = param.Range(allow_None=True, allow_refs=False, constant=True, inclusive_bounds=(True, True), label=’Value throttled’, length=2, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17a661f50>): The value of the slider. Updated when the handle is released.
start = param.Number(allow_refs=False, default=0.0, inclusive_bounds=(True, True), label=’Start’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17a663bd0>): Lower bound of the range.
end = param.Number(allow_refs=False, default=1.0, inclusive_bounds=(True, True), label=’End’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17a661ed0>): Upper bound of the range.
fixed_start = param.Number(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’Fixed start’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17a663b10>): A fixed lower bound for the slider and input.
fixed_end = param.Number(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’Fixed end’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17a663f90>): A fixed upper bound for the slider and input.
step = param.Number(allow_refs=False, default=0.1, inclusive_bounds=(True, True), label=’Step’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17a663b10>): Slider and number input step.
editable = param.Tuple(allow_refs=False, default=(True, True), label=’Editable’, length=2, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x179361250>): Whether the lower and upper values are editable.
format = param.ClassSelector(allow_refs=False, class_=(<class ‘str’>, <class ‘bokeh.models.formatters.TickFormatter’>), default=’0.0[0000]’, label=’Format’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17a663050>): Allows defining a custom format string or bokeh TickFormatter.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.slider.FloatSlider(*, end, start, step, value_throttled, format, bar_color, direction, orientation, show_value, tooltips, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: ContinuousSlider

The FloatSlider widget allows selecting a floating-point value within a set of bounds using a slider.

Reference: https://panel.holoviz.org/reference/widgets/FloatSlider.html

Example:

>>> FloatSlider(value=0.5, start=0.0, end=1.0, step=0.1, name="Float value")

Parameters inherited from:

value = param.Number(allow_None=True, allow_refs=False, default=0.0, inclusive_bounds=(True, True), label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17a678110>): The selected floating-point value of the slider. Updated when the handle is dragged.
start = param.Number(allow_refs=False, default=0.0, inclusive_bounds=(True, True), label=’Start’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17a679f10>): The lower bound.
end = param.Number(allow_refs=False, default=1.0, inclusive_bounds=(True, True), label=’End’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17a678050>): The upper bound.
step = param.Number(allow_refs=False, default=0.1, inclusive_bounds=(True, True), label=’Step’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17a679e50>): The step size.
value_throttled = param.Number(allow_None=True, allow_refs=False, constant=True, inclusive_bounds=(True, True), label=’Value throttled’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17a6782d0>): The value of the slider. Updated when the handle is released.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.slider.IntRangeSlider(*, end, format, start, step, value_throttled, bar_color, direction, orientation, show_value, tooltips, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: RangeSlider

The IntRangeSlider widget allows selecting an integer range using a slider with two handles.

Reference: https://panel.holoviz.org/reference/widgets/IntRangeSlider.html

Example:

>>> IntRangeSlider(
...     value=(2, 4), start=0, end=10, step=2, name="A tuple of integers"
... )

Parameters inherited from:

start = param.Integer(allow_refs=False, default=0, inclusive_bounds=(True, True), label=’Start’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17a694110>): The lower bound.
end = param.Integer(allow_refs=False, default=1, inclusive_bounds=(True, True), label=’End’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17a695f10>): The upper bound.
step = param.Integer(allow_refs=False, default=1, inclusive_bounds=(True, True), label=’Step’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17a694050>): The step size

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.slider.IntSlider(*, end, start, step, value_throttled, format, bar_color, direction, orientation, show_value, tooltips, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: ContinuousSlider

The IntSlider widget allows selecting an integer value within a set of bounds using a slider.

Reference: https://panel.holoviz.org/reference/widgets/IntSlider.html

Example:

>>> IntSlider(value=5, start=0, end=10, step=1, name="Integer Value")

Parameters inherited from:

value = param.Integer(allow_None=True, allow_refs=False, default=0, inclusive_bounds=(True, True), label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17a6cb250>): The selected integer value of the slider. Updated when the handle is dragged.
start = param.Integer(allow_refs=False, default=0, inclusive_bounds=(True, True), label=’Start’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17a6b1090>): The lower bound.
end = param.Integer(allow_refs=False, default=1, inclusive_bounds=(True, True), label=’End’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17a6cb190>): The upper bound.
step = param.Integer(allow_refs=False, default=1, inclusive_bounds=(True, True), label=’Step’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17a6b0fd0>): The step size.
value_throttled = param.Integer(allow_None=True, allow_refs=False, constant=True, inclusive_bounds=(True, True), label=’Value throttled’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17a6cb410>): The value of the slider. Updated when the handle is released

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

class panel.widgets.slider.RangeSlider(*, end, format, start, step, value_throttled, bar_color, direction, orientation, show_value, tooltips, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: _RangeSliderBase

The RangeSlider widget allows selecting a floating-point range using a slider with two handles.

Reference: https://panel.holoviz.org/reference/widgets/RangeSlider.html

Example:

>>> RangeSlider(
...     value=(1.0, 1.5), start=0.0, end=2.0, step=0.25, name="A tuple of floats"
... )

Parameters inherited from:

value = param.Range(allow_refs=False, default=(0, 1), inclusive_bounds=(True, True), label=’Value’, length=2, nested_refs=True, rx=<param.reactive.reactive_ops object at 0x17a6e1290>): The selected range as a tuple of values. Updated when a handle is dragged.
value_start = param.Number(allow_refs=False, constant=True, default=0, inclusive_bounds=(True, True), label=’Value start’, nested_refs=False, readonly=True, rx=<param.reactive.reactive_ops object at 0x17a6e2ed0>): The lower value of the selected range.
value_end = param.Number(allow_refs=False, constant=True, default=1, inclusive_bounds=(True, True), label=’Value end’, nested_refs=False, readonly=True, rx=<param.reactive.reactive_ops object at 0x17a6e1290>): The upper value of the selected range.
value_throttled = param.Range(allow_None=True, allow_refs=False, constant=True, inclusive_bounds=(True, True), label=’Value throttled’, length=2, nested_refs=True, rx=<param.reactive.reactive_ops object at 0x17a6e2b90>): The selected range as a tuple of floating point values. Updated when a handle is released
start = param.Number(allow_refs=False, default=0, inclusive_bounds=(True, True), label=’Start’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17a6e32d0>): The lower bound.
end = param.Number(allow_refs=False, default=1, inclusive_bounds=(True, True), label=’End’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17a6e2ad0>): The upper bound.
step = param.Number(allow_refs=False, default=0.1, inclusive_bounds=(True, True), label=’Step’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17a6e3290>): The step size.
format = param.ClassSelector(allow_None=True, allow_refs=False, class_=(<class ‘str’>, <class ‘bokeh.models.formatters.TickFormatter’>), label=’Format’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17a6e2650>): A format string or bokeh TickFormatter.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

`speech_to_text` Module#

The SpeechToText widget controls the speech recognition service of the browser.

It wraps the HTML5 SpeechRecognition API. See https://developer.mozilla.org/en-US/docs/Web/API/SpeechRecognition

This functionality is experimental and only supported by Chrome and a few other browsers. Checkout https://caniuse.com/speech-recognition for a up to date list of browsers supporting the SpeechRecognition Api. Or alternatively https://developer.mozilla.org/en-US/docs/Web/API/SpeechRecognition#Browser_compatibility

On some browsers, like Chrome, using Speech Recognition on a web page involves a server-based recognition engine. Your audio is sent to a web service for recognition processing, so it won’t work offline. Whether this is secure and confidential enough for your use case is up to you to evaluate.

class panel.widgets.speech_to_text.Grammar(*, src, uri, weight, name)[source]#

Bases: Parameterized

A set of words or patterns of words that we want the speech recognition service to recognize

For example

grammar = Grammar(: src=’#JSGF V1.0; grammar colors; public <color> = aqua | azure | beige;’, weight=0.7

)

Wraps the HTML SpeechGrammar API. See https://developer.mozilla.org/en-US/docs/Web/API/SpeechGrammar

src = param.String(allow_refs=False, default=’’, label=’Src’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17ba73610>): A set of words or patterns of words that we want the recognition service to recognize. Defined using JSpeech Grammar Format. See https://www.w3.org/TR/jsgf/.
uri = param.String(allow_refs=False, default=’’, label=’Uri’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17ba789d0>): An uri pointing to the definition. If src is available it will be used. Otherwise uri. The uri will be loaded on the client side only.
weight = param.Number(allow_refs=False, bounds=(0.0, 1.0), default=1, inclusive_bounds=(True, True), label=’Weight’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17ba78d50>, step=0.01): The weight of the grammar. A number in the range 0–1. Default is 1.

serialize()[source]#: Returns the grammar as dict

class panel.widgets.speech_to_text.GrammarList(iterable=(), /)[source]#

Bases: list

A list of Grammar objects containing words or patterns of words that we want the recognition service to recognize.

Example:

grammar = ‘#JSGF V1.0; grammar colors; public <color> = aqua | azure | beige | bisque ;’ grammar_list = GrammarList() grammar_list.add_from_string(grammar, 1)

Wraps the HTML 5 SpeechGrammarList API

See https://developer.mozilla.org/en-US/docs/Web/API/SpeechGrammarList

add_from_string(src, weight=1.0)[source]#: Takes a src and weight and adds it to the GrammarList as a new Grammar object. The new Grammar object is returned.

add_from_uri(uri, weight=1.0)[source]#: Takes a grammar present at a specific uri, and adds it to the GrammarList as a new Grammar object. The new Grammar object is returned.

append(object, /)#: Append object to the end of the list.

clear()#: Remove all items from list.

copy()#: Return a shallow copy of the list.

count(value, /)#: Return number of occurrences of value.

extend(iterable, /)#: Extend list by appending elements from the iterable.

index(value, start=0, stop=9223372036854775807, /)#

Return first index of value.

Raises ValueError if the value is not present.

insert(index, object, /)#: Insert object before index.

pop(index=-1, /)#

Remove and return item at index (default last).

Raises IndexError if list is empty or index is out of range.

remove(value, /)#

Remove first occurrence of value.

Raises ValueError if the value is not present.

reverse()#: Reverse IN PLACE.

serialize()[source]#: Returns a list of serialized grammars

sort(*, key=None, reverse=False)#

Sort the list in ascending order and return None.

The sort is in-place (i.e. the list itself is modified) and stable (i.e. the order of two equal elements is maintained).

If a key function is given, apply it once to each list item and sort them, ascending or descending, according to their function values.

The reverse flag can be set to sort in descending order.

class panel.widgets.speech_to_text.Language(*, country, family, name)[source]#

Bases: Parameterized

country = param.String(allow_refs=False, default=’’, label=’Country’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17ba6b250>): A country like ‘United States’
family = param.String(allow_refs=False, default=’’, label=’Family’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17bacbd90>): The overall language family. For example ‘English’.

class panel.widgets.speech_to_text.RecognitionAlternative(*, confidence, transcript, name)[source]#

Bases: Parameterized

The RecognitionAlternative represents a word or sentence that has been recognised by the speech recognition service.

Wraps the HTML5 SpeechRecognitionAlternative API

See https://developer.mozilla.org/en-US/docs/Web/API/SpeechRecognitionAlternative

confidence = param.Number(allow_refs=False, bounds=(0.0, 1.0), constant=True, default=0.0, inclusive_bounds=(True, True), label=’Confidence’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17ba7a350>): A numeric estimate between 0 and 1 of how confident the speech recognition system is that the recognition is correct.
transcript = param.String(allow_refs=False, constant=True, default=’’, label=’Transcript’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17ba7b190>): The transcript of the recognised word or sentence.

class panel.widgets.speech_to_text.RecognitionResult(*, alternatives, is_final, name)[source]#

Bases: Parameterized

The Result represents a single recognition match, which may contain multiple RecognitionAlternative objects.

Wraps the HTML5 SpeechRecognitionResult API.

See https://developer.mozilla.org/en-US/docs/Web/API/SpeechRecognitionResult

alternatives = param.List(allow_refs=False, bounds=(0, None), class_=<class ‘panel.widgets.speech_to_text.RecognitionAlternative’>, constant=True, default=[], item_type=<class ‘panel.widgets.speech_to_text.RecognitionAlternative’>, label=’Alternatives’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17ba7bf50>): The list of the n-best alternatives
is_final = param.Boolean(allow_refs=False, constant=True, default=False, label=’Is final’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x175d285d0>): A Boolean that states whether this result is final (True) or not (False) — if so, then this is the final time this result will be returned; if not, then this result is an interim result, and may be updated later on.

classmethod create_from_dict(result)[source]#: Deserializes a serialized RecognitionResult

classmethod create_from_list(results)[source]#: Deserializes a list of serialized RecognitionResults.

class panel.widgets.speech_to_text.SpeechToText(*, _grammars, abort, audio_started, button_hide, button_not_started, button_started, button_type, continuous, grammars, interim_results, lang, max_alternatives, results, service_uri, sound_started, speech_started, start, started, stop, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: Widget

The SpeechToText widget controls the speech recognition service of the browser.

It wraps the HTML5 SpeechRecognition API. See https://developer.mozilla.org/en-US/docs/Web/API/SpeechRecognition

Reference: https://panel.holoviz.org/reference/widgets/SpeechToText.html

Example:

>>> SpeechToText(button_type="light")

This functionality is experimental and only supported by Chrome and a few other browsers. Checkout https://caniuse.com/speech-recognition for a up to date list of browsers supporting the SpeechRecognition Api. Or alternatively https://developer.mozilla.org/en-US/docs/Web/API/SpeechRecognition#Browser_compatibility

On some browsers, like Chrome, using Speech Recognition on a web page involves a server-based recognition engine. Your audio is sent to a web service for recognition processing, so it won’t work offline. Whether this is secure and confidential enough for your use case is up to you to evaluate.

Parameters inherited from:

value = param.String(allow_refs=False, constant=True, default=’’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17ba80210>): The transcipt of the highest confidence RecognitionAlternative of the last RecognitionResult. Please note we strip the transcript for leading spaces.
abort = param.Event(allow_refs=False, default=False, label=’Abort’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17b3b35d0>): Stops the speech recognition service from listening to incoming audio, and doesn’t attempt to return a RecognitionResult.
start = param.Event(allow_refs=False, default=False, label=’Start’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17ba801d0>): Starts the speech recognition service listening to incoming audio with intent to recognize grammars associated with the current SpeechRecognition.
stop = param.Event(allow_refs=False, default=False, label=’Stop’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17ba80850>): Stops the speech recognition service from listening to incoming audio, and attempts to return a RecognitionResult using the audio captured so far.
lang = param.ObjectSelector(allow_None=True, allow_refs=False, default=’’, names={}, nested_refs=False, objects=[‘’, ‘af-ZA’, ‘ar-AE’, ‘ar-BH’, ‘ar-DZ’, ‘ar-EG’, ‘ar-IL’, ‘ar-IQ’, ‘ar-JO’, ‘ar-KW’, ‘ar-LB’, ‘ar-MA’, ‘ar-OM’, ‘ar-PS’, ‘ar-QA’, ‘ar-SA’, ‘ar-TN’, ‘bg-BG’, ‘ca-ES’, ‘cmn-Hans-CN’, ‘cmn-Hans-HK’, ‘cmn-Hant-TW’, ‘cs-CZ’, ‘da-DK’, ‘de-DE’, ‘el-GR’, ‘en-AU’, ‘en-CA’, ‘en-GB’, ‘en-IE’, ‘en-IN’, ‘en-NZ’, ‘en-PH’, ‘en-US’, ‘en-ZA’, ‘es-AR’, ‘es-BO’, ‘es-CL’, ‘es-CO’, ‘es-CR’, ‘es-DO’, ‘es-EC’, ‘es-ES’, ‘es-GT’, ‘es-HN’, ‘es-MX’, ‘es-NI’, ‘es-PA’, ‘es-PE’, ‘es-PR’, ‘es-PY’, ‘es-SV’, ‘es-US’, ‘es-UY’, ‘es-VE’, ‘eu-ES’, ‘fa-IR’, ‘fi-FI’, ‘fil-PH’, ‘fr-FR’, ‘gl-ES’, ‘he-IL’, ‘hi-IN’, ‘hr_HR’, ‘hu-HU’, ‘id-ID’, ‘is-IS’, ‘it-CH’, ‘it-IT’, ‘ja-JP’, ‘ko-KR’, ‘lt-LT’, ‘ms-MY’, ‘nb-NO’, ‘nl-NL’, ‘pl-PL’, ‘pt-BR’, ‘pt-PT’, ‘ro-RO’, ‘ru-RU’, ‘sk-SK’, ‘sl-SI’, ‘sr-RS’, ‘sv-SE’, ‘th-TH’, ‘tr-TR’, ‘uk-UA’, ‘vi-VN’, ‘yue-Hant-HK’, ‘zu-ZA’], rx=<param.reactive.reactive_ops object at 0x17ba801d0>): The language of the current SpeechRecognition in BCP 47 format. For example ‘en-US’. If not specified, this defaults to the HTML lang attribute value, or the user agent’s language setting if that isn’t set either.
continuous = param.Boolean(allow_refs=False, default=False, label=’Continuous’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17ba807d0>): Controls whether continuous results are returned for each recognition, or only a single result. Defaults to False
interim_results = param.Boolean(allow_refs=False, default=False, label=’Interim results’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17ba800d0>): Controls whether interim results should be returned (True) or not (False.) Interim results are results that are not yet final (e.g. the RecognitionResult.is_final property is False).
max_alternatives = param.Integer(allow_refs=False, bounds=(1, 5), default=1, inclusive_bounds=(True, True), label=’Max alternatives’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17ba80e50>): Sets the maximum number of RecognitionAlternatives provided per result. A number between 1 and 5. The default value is 1.
service_uri = param.String(allow_refs=False, default=’’, label=’Service uri’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17ba80150>): Specifies the location of the speech recognition service used by the current SpeechRecognition to handle the actual recognition. The default is the user agent’s default speech service.
grammars = param.ClassSelector(allow_None=True, allow_refs=False, class_=<class ‘panel.widgets.speech_to_text.GrammarList’>, label=’Grammars’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17ba80490>): A GrammarList object that represents the grammars that will be understood by the current SpeechRecognition service
button_hide = param.Boolean(allow_refs=False, default=False, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17ba800d0>): If True no button is shown. If False a toggle Start/ Stop button is shown.
button_type = param.ObjectSelector(allow_refs=False, default=’light’, label=’Button type’, names={}, nested_refs=False, objects=[‘default’, ‘primary’, ‘success’, ‘warning’, ‘danger’, ‘light’, ‘light’, ‘dark’], rx=<param.reactive.reactive_ops object at 0x17ba80610>): The button styling.
button_not_started = param.String(allow_refs=False, default=’’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17ba800d0>): The text to show on the button when the SpeechRecognition service is NOT started. If ‘’ a muted microphone icon is shown.
button_started = param.String(allow_refs=False, default=’’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17ba80710>): The text to show on the button when the SpeechRecognition service is started. If ‘’ a muted microphone icon is shown.
started = param.Boolean(allow_refs=False, constant=True, default=False, label=’Started’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17ba80dd0>): Returns True if the Speech Recognition Service is started and False otherwise.
audio_started = param.Boolean(allow_refs=False, constant=True, default=False, label=’Audio started’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17ba80410>): Returns True if the Audio is started and False otherwise.
sound_started = param.Boolean(allow_refs=False, constant=True, default=False, label=’Sound started’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17ba80610>): Returns True if the Sound is started and False otherwise.
speech_started = param.Boolean(allow_refs=False, constant=True, default=False, label=’Speech started’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17ba80590>): Returns True if the the User has started speaking and False otherwise.
results = param.List(allow_refs=False, bounds=(0, None), constant=True, default=[], label=’Results’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17ba81150>): The results as a list of Dictionaries.
_grammars = param.List(allow_refs=False, bounds=(0, None), constant=True, default=[], label=’ grammars’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17ba80510>): List used to transfer the serialized grammars from server to browser.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

property results_as_html: str#

Returns the results formatted as html

Convenience method for ease of use

property results_deserialized#: Returns the results as a List of RecognitionResults

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

`tables` Module#

class panel.widgets.tables.BaseTable(value=None, **params)[source]#

Bases: ReactiveData, Widget

Parameters inherited from:

value = param.Parameter(allow_None=True, allow_refs=True, label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17bd0ea10>): The widget value which the widget type resolves to when used as a reactive param reference.
selection = param.List(allow_refs=False, bounds=(0, None), default=[], item_type=<class ‘int’>, label=’Selection’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17bcf6250>): The currently selected rows of the table.
aggregators = param.Dict(allow_refs=True, class_=<class ‘dict’>, default={}, label=’Aggregators’, nested_refs=True, rx=<param.reactive.reactive_ops object at 0x17bcf6850>): A dictionary mapping from index name to an aggregator to be used for hierarchical multi-indexes (valid aggregators include ‘min’, ‘max’, ‘mean’ and ‘sum’). If separate aggregators for different columns are required the dictionary may be nested as {index_name: {column_name: aggregator}}
editors = param.Dict(allow_refs=True, class_=<class ‘dict’>, default={}, label=’Editors’, nested_refs=True, rx=<param.reactive.reactive_ops object at 0x17bcf6a50>): Bokeh CellEditor to use for a particular column (overrides the default chosen based on the type).
formatters = param.Dict(allow_refs=True, class_=<class ‘dict’>, default={}, label=’Formatters’, nested_refs=True, rx=<param.reactive.reactive_ops object at 0x17bcf6890>): Bokeh CellFormatter to use for a particular column (overrides the default chosen based on the type).
hierarchical = param.Boolean(allow_refs=True, constant=True, default=False, label=’Hierarchical’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17bcf6250>): Whether to generate a hierarchical index.
row_height = param.Integer(allow_refs=False, default=40, inclusive_bounds=(True, True), label=’Row height’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17bcf7810>): The height of each table row.
show_index = param.Boolean(allow_refs=True, default=True, label=’Show index’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17bcf6a10>): Whether to show the index column.
sorters = param.List(allow_refs=True, bounds=(0, None), default=[], label=’Sorters’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17bcf6ed0>): A list of sorters to apply during pagination.
text_align = param.ClassSelector(allow_refs=True, class_=(<class ‘dict’>, <class ‘str’>), default={}, label=’Text align’, nested_refs=True, rx=<param.reactive.reactive_ops object at 0x17bccfb10>): A mapping from column name to alignment or a fixed column alignment, which should be one of ‘left’, ‘center’, ‘right’.
titles = param.Dict(allow_refs=True, class_=<class ‘dict’>, default={}, label=’Titles’, nested_refs=True, rx=<param.reactive.reactive_ops object at 0x17bcf62d0>): A mapping from column name to a title to override the name with.
widths = param.ClassSelector(allow_refs=True, class_=(<class ‘dict’>, <class ‘int’>), default={}, label=’Widths’, nested_refs=True, rx=<param.reactive.reactive_ops object at 0x17bcf5710>): A mapping from column name to column width or a fixed column width.

add_filter(filter, column=None)[source]#

Adds a filter to the table which can be a static value or dynamic parameter based object which will automatically update the table when changed..

When a static value, widget or parameter is supplied the filtering will follow a few well defined behaviors:

Arguments#

filter: Widget, param.Parameter or FunctionType: The value by which to filter the DataFrame along the declared column, or a function accepting the DataFrame to be filtered and returning a filtered copy of the DataFrame.
column: str or None: Column to which the filter will be applied, if the filter is a constant value, widget or parameter.

Raises#

ValueError: If the filter type is not supported or no column: was declared.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

property current_view#: Returns the current view of the table after filtering and sorting are applied.

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

patch(patch_value, as_index=True)[source]#

Efficiently patches (updates) the existing value with the patch_value.

Arguments#

patch_value: (pd.DataFrame | pd.Series | Dict): The value(s) to patch the existing value with.
as_index: boolean: Whether to treat the patch index as DataFrame indexes (True) or as simple integer index.

Raises#

ValueError: Raised if the patch_value is not a supported type.

Examples#

Patch a DataFrame with a Dictionary row. >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> tabulator = Tabulator(value=value) >>> patch_value = {“x”: [(0, 3)]} >>> tabulator.patch(patch_value) >>> tabulator.value.to_dict(“list”) {‘x’: [3, 2], ‘y’: [‘a’, ‘b’]}

Patch a Dataframe with a Dictionary of Columns. >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> tabulator = Tabulator(value=value) >>> patch_value = {“x”: [(slice(2), (3,4))], “y”: [(1,’d’)]} >>> tabulator.patch(patch_value) >>> tabulator.value.to_dict(“list”) {‘x’: [3, 4], ‘y’: [‘a’, ‘d’]}

Patch a DataFrame with a Series. Please note the index is used in the update. >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> tabulator = Tabulator(value=value) >>> patch_value = pd.Series({“index”: 1, “x”: 4, “y”: “d”}) >>> tabulator.patch(patch_value) >>> tabulator.value.to_dict(“list”) {‘x’: [1, 4], ‘y’: [‘a’, ‘d’]}

Patch a Dataframe with a Dataframe. Please note the index is used in the update. >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> tabulator = Tabulator(value=value) >>> patch_value = pd.DataFrame({“x”: [3, 4], “y”: [“c”, “d”]}) >>> tabulator.patch(patch_value) >>> tabulator.value.to_dict(“list”) {‘x’: [3, 4], ‘y’: [‘c’, ‘d’]}

remove_filter(filter)[source]#: Removes a filter which was previously added.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

property selected_dataframe#: Returns a DataFrame of the currently selected rows.

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

stream(stream_value, rollover=None, reset_index=True)[source]#

Streams (appends) the stream_value provided to the existing value in an efficient manner.

Arguments#

stream_value: (pd.DataFrame | pd.Series | Dict): The new value(s) to append to the existing value.
rollover: int: A maximum column size, above which data from the start of the column begins to be discarded. If None, then columns will continue to grow unbounded.
reset_index: (bool, default=True): If True and the stream_value is a DataFrame, then its index is reset. Helps to keep the index unique and named index

Raises#

ValueError: Raised if the stream_value is not a supported type.

Examples#

Stream a Series to a DataFrame >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> tabulator = Tabulator(value=value) >>> stream_value = pd.Series({“x”: 4, “y”: “d”}) >>> tabulator.stream(stream_value) >>> tabulator.value.to_dict(“list”) {‘x’: [1, 2, 4], ‘y’: [‘a’, ‘b’, ‘d’]}

Stream a Dataframe to a Dataframe >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> tabulator = Tabulator(value=value) >>> stream_value = pd.DataFrame({“x”: [3, 4], “y”: [“c”, “d”]}) >>> tabulator.stream(stream_value) >>> tabulator.value.to_dict(“list”) {‘x’: [1, 2, 3, 4], ‘y’: [‘a’, ‘b’, ‘c’, ‘d’]}

Stream a Dictionary row to a DataFrame >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> tabulator = Tabulator(value=value) >>> stream_value = {“x”: 4, “y”: “d”} >>> tabulator.stream(stream_value) >>> tabulator.value.to_dict(“list”) {‘x’: [1, 2, 4], ‘y’: [‘a’, ‘b’, ‘d’]}

Stream a Dictionary of Columns to a Dataframe >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> tabulator = Tabulator(value=value) >>> stream_value = {“x”: [3, 4], “y”: [“c”, “d”]} >>> tabulator.stream(stream_value) >>> tabulator.value.to_dict(“list”) {‘x’: [1, 2, 3, 4], ‘y’: [‘a’, ‘b’, ‘c’, ‘d’]}

class panel.widgets.tables.DataFrame(value=None, **params)[source]#

Bases: BaseTable

The DataFrame widget allows displaying and editing a pandas DataFrame.

Note that editing is not possible for multi-indexed DataFrames, in which case you will need to reduce the DataFrame to a single index.

Also note that the DataFrame widget will eventually be replaced with the Tabulator widget, and so new code should be written to use Tabulator instead.

Reference: https://panel.holoviz.org/reference/widgets/DataFrame.html

Example:

>>> DataFrame(df, name='DataFrame')

Parameters inherited from:

auto_edit = param.Boolean(allow_refs=False, default=False, label=’Auto edit’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17bd33810>): Whether clicking on a table cell automatically starts edit mode.
autosize_mode = param.ObjectSelector(allow_refs=False, default=’force_fit’, label=’Autosize mode’, names={}, nested_refs=False, objects=[‘none’, ‘fit_columns’, ‘fit_viewport’, ‘force_fit’], rx=<param.reactive.reactive_ops object at 0x17bd38e90>): Determines the column autosizing mode, as one of the following options: "fit_columns" Compute column widths based on cell contents while ensuring the table fits into the available viewport. This results in no horizontal scrollbar showing up, but data can get unreadable if there is not enough space available. "fit_viewport" Adjust the viewport size after computing column widths based on cell contents. "force_fit" Fit columns into available space dividing the table width across the columns equally (equivalent to fit_columns=True). This results in no horizontal scrollbar showing up, but data can get unreadable if there is not enough space available. "none" Do not automatically compute column widths.
fit_columns = param.Boolean(allow_None=True, allow_refs=False, label=’Fit columns’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17bd338d0>): Whether columns should expand to the available width. This results in no horizontal scrollbar showing up, but data can get unreadable if there is no enough space available.
frozen_columns = param.Integer(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’Frozen columns’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17bd39010>): Integer indicating the number of columns to freeze. If set, the first N columns will be frozen, which prevents them from scrolling out of frame.
frozen_rows = param.Integer(allow_None=True, allow_refs=False, inclusive_bounds=(True, True), label=’Frozen rows’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17bd39710>): Integer indicating the number of rows to freeze. If set, the first N rows will be frozen, which prevents them from scrolling out of frame; if set to a negative value the last N rows will be frozen.
reorderable = param.Boolean(allow_refs=False, default=True, label=’Reorderable’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17bd38750>): Allows the reordering of a table’s columns. To reorder a column, click and drag a table’s header to the desired location in the table. The columns on either side will remain in their previous order.
sortable = param.Boolean(allow_refs=False, default=True, label=’Sortable’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17bd338d0>): Allows to sort table’s contents. By default natural order is preserved. To sort a column, click on its header. Clicking one more time changes sort direction. Use Ctrl + click to return to natural order. Use Shift + click to sort multiple columns simultaneously.

add_filter(filter, column=None)[source]#

Adds a filter to the table which can be a static value or dynamic parameter based object which will automatically update the table when changed..

When a static value, widget or parameter is supplied the filtering will follow a few well defined behaviors:

Arguments#

filter: Widget, param.Parameter or FunctionType: The value by which to filter the DataFrame along the declared column, or a function accepting the DataFrame to be filtered and returning a filtered copy of the DataFrame.
column: str or None: Column to which the filter will be applied, if the filter is a constant value, widget or parameter.

Raises#

ValueError: If the filter type is not supported or no column: was declared.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

property current_view#: Returns the current view of the table after filtering and sorting are applied.

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

patch(patch_value, as_index=True)[source]#

Efficiently patches (updates) the existing value with the patch_value.

Arguments#

patch_value: (pd.DataFrame | pd.Series | Dict): The value(s) to patch the existing value with.
as_index: boolean: Whether to treat the patch index as DataFrame indexes (True) or as simple integer index.

Raises#

ValueError: Raised if the patch_value is not a supported type.

Examples#

Patch a DataFrame with a Dictionary row. >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> tabulator = Tabulator(value=value) >>> patch_value = {“x”: [(0, 3)]} >>> tabulator.patch(patch_value) >>> tabulator.value.to_dict(“list”) {‘x’: [3, 2], ‘y’: [‘a’, ‘b’]}

Patch a Dataframe with a Dictionary of Columns. >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> tabulator = Tabulator(value=value) >>> patch_value = {“x”: [(slice(2), (3,4))], “y”: [(1,’d’)]} >>> tabulator.patch(patch_value) >>> tabulator.value.to_dict(“list”) {‘x’: [3, 4], ‘y’: [‘a’, ‘d’]}

Patch a DataFrame with a Series. Please note the index is used in the update. >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> tabulator = Tabulator(value=value) >>> patch_value = pd.Series({“index”: 1, “x”: 4, “y”: “d”}) >>> tabulator.patch(patch_value) >>> tabulator.value.to_dict(“list”) {‘x’: [1, 4], ‘y’: [‘a’, ‘d’]}

Patch a Dataframe with a Dataframe. Please note the index is used in the update. >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> tabulator = Tabulator(value=value) >>> patch_value = pd.DataFrame({“x”: [3, 4], “y”: [“c”, “d”]}) >>> tabulator.patch(patch_value) >>> tabulator.value.to_dict(“list”) {‘x’: [3, 4], ‘y’: [‘c’, ‘d’]}

remove_filter(filter)[source]#: Removes a filter which was previously added.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

property selected_dataframe#: Returns a DataFrame of the currently selected rows.

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

stream(stream_value, rollover=None, reset_index=True)[source]#

Streams (appends) the stream_value provided to the existing value in an efficient manner.

Arguments#

stream_value: (pd.DataFrame | pd.Series | Dict): The new value(s) to append to the existing value.
rollover: int: A maximum column size, above which data from the start of the column begins to be discarded. If None, then columns will continue to grow unbounded.
reset_index: (bool, default=True): If True and the stream_value is a DataFrame, then its index is reset. Helps to keep the index unique and named index

Raises#

ValueError: Raised if the stream_value is not a supported type.

Examples#

Stream a Series to a DataFrame >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> tabulator = Tabulator(value=value) >>> stream_value = pd.Series({“x”: 4, “y”: “d”}) >>> tabulator.stream(stream_value) >>> tabulator.value.to_dict(“list”) {‘x’: [1, 2, 4], ‘y’: [‘a’, ‘b’, ‘d’]}

Stream a Dataframe to a Dataframe >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> tabulator = Tabulator(value=value) >>> stream_value = pd.DataFrame({“x”: [3, 4], “y”: [“c”, “d”]}) >>> tabulator.stream(stream_value) >>> tabulator.value.to_dict(“list”) {‘x’: [1, 2, 3, 4], ‘y’: [‘a’, ‘b’, ‘c’, ‘d’]}

Stream a Dictionary row to a DataFrame >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> tabulator = Tabulator(value=value) >>> stream_value = {“x”: 4, “y”: “d”} >>> tabulator.stream(stream_value) >>> tabulator.value.to_dict(“list”) {‘x’: [1, 2, 4], ‘y’: [‘a’, ‘b’, ‘d’]}

Stream a Dictionary of Columns to a Dataframe >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> tabulator = Tabulator(value=value) >>> stream_value = {“x”: [3, 4], “y”: [“c”, “d”]} >>> tabulator.stream(stream_value) >>> tabulator.value.to_dict(“list”) {‘x’: [1, 2, 3, 4], ‘y’: [‘a’, ‘b’, ‘c’, ‘d’]}

class panel.widgets.tables.Tabulator(value=None, **params)[source]#

Bases: BaseTable

The Tabulator widget wraps the [Tabulator js](http://tabulator.info/) table to provide a full-featured, very powerful interactive table.

Reference: https://panel.holoviz.org/reference/widgets/Tabulator.html

Example:

>>> Tabulator(df, theme='site', pagination='remote', page_size=25)

Parameters inherited from:

selection = param._ListValidateWithCallable(allow_refs=True, bounds=(0, None), default=[], item_type=<class ‘int’>, label=’Selection’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17bd6ab90>): The currently selected rows of the table. It validates its values against ‘selectable_rows’ if used.
row_height = param.Integer(allow_refs=True, default=30, inclusive_bounds=(True, True), label=’Row height’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17bd58810>): The height of each table row.
buttons = param.Dict(allow_refs=True, class_=<class ‘dict’>, default={}, label=’Buttons’, nested_refs=True, rx=<param.reactive.reactive_ops object at 0x17bd68950>): Dictionary mapping from column name to a HTML element to use as the button icon.
expanded = param.List(allow_refs=True, bounds=(0, None), default=[], label=’Expanded’, nested_refs=True, rx=<param.reactive.reactive_ops object at 0x17bd1bc90>): List of expanded rows, only applicable if a row_content function has been defined.
embed_content = param.Boolean(allow_refs=True, default=False, label=’Embed content’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17bd3eed0>): Whether to embed the row_content or render it dynamically when a row is expanded.
filters = param.List(allow_refs=True, bounds=(0, None), default=[], label=’Filters’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17bd6bf90>): List of client-side filters declared as dictionaries containing ‘field’, ‘type’ and ‘value’ keys.
frozen_columns = param.ClassSelector(allow_refs=True, class_=(<class ‘list’>, <class ‘dict’>), default=[], label=’Frozen columns’, nested_refs=True, rx=<param.reactive.reactive_ops object at 0x17bd68450>): One of: - List indicating the columns to freeze. The column(s) may be selected by name or index. - Dict indicating columns to freeze as keys and their freeze location as values, freeze location is either ‘right’ or ‘left’.
frozen_rows = param.List(allow_refs=True, bounds=(0, None), default=[], label=’Frozen rows’, nested_refs=True, rx=<param.reactive.reactive_ops object at 0x17bd6aad0>): List indicating the rows to freeze. If set, the first N rows will be frozen, which prevents them from scrolling out of frame; if set to a negative value the last N rows will be frozen.
groups = param.Dict(allow_refs=True, class_=<class ‘dict’>, default={}, label=’Groups’, nested_refs=True, rx=<param.reactive.reactive_ops object at 0x17bd6ac10>): Dictionary mapping defining the groups.
groupby = param.List(allow_refs=True, bounds=(0, None), default=[], label=’Groupby’, nested_refs=True, rx=<param.reactive.reactive_ops object at 0x17bd6ab90>): Groups rows in the table by one or more columns.
header_align = param.ClassSelector(allow_refs=True, class_=(<class ‘dict’>, <class ‘str’>), default={}, label=’Header align’, nested_refs=True, rx=<param.reactive.reactive_ops object at 0x17bd689d0>): A mapping from column name to alignment or a fixed column alignment, which should be one of ‘left’, ‘center’, ‘right’.
header_filters = param.ClassSelector(allow_None=True, allow_refs=True, class_=(<class ‘bool’>, <class ‘dict’>), label=’Header filters’, nested_refs=True, rx=<param.reactive.reactive_ops object at 0x17bd68450>): Whether to enable filters in the header or dictionary configuring filters for each column.
header_tooltips = param.Dict(allow_refs=True, class_=<class ‘dict’>, default={}, label=’Header tooltips’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17bd68990>): Dictionary mapping from column name to a tooltip to show when hovering over the column header.
hidden_columns = param.List(allow_refs=True, bounds=(0, None), default=[], label=’Hidden columns’, nested_refs=True, rx=<param.reactive.reactive_ops object at 0x17bd68110>): List of columns to hide.

layout = param.ObjectSelector(allow_refs=True, default=’fit_data_table’, label=’Layout’, names={}, nested_refs=False, objects=[‘fit_data’, ‘fit_data_fill’, ‘fit_data_stretch’, ‘fit_data_table’, ‘fit_columns’], rx=<param.reactive.reactive_ops object at 0x17bd6bf90>)

initial_page_size = param.Integer(allow_refs=True, bounds=(1, None), default=20, inclusive_bounds=(True, True), label=’Initial page size’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17bd68950>): Initial page size if page_size is None and therefore automatically set.

pagination = param.ObjectSelector(allow_None=True, allow_refs=True, label=’Pagination’, names={}, nested_refs=False, objects=[‘local’, ‘remote’], rx=<param.reactive.reactive_ops object at 0x17bd6bf90>)

page = param.Integer(allow_refs=True, default=1, inclusive_bounds=(True, True), label=’Page’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17bd580d0>): Currently selected page (indexed starting at 1), if pagination is enabled.
page_size = param.Integer(allow_None=True, allow_refs=True, bounds=(1, None), inclusive_bounds=(True, True), label=’Page size’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17bd58910>): Number of rows to render per page, if pagination is enabled.
row_content = param.Callable(allow_None=True, allow_refs=True, label=’Row content’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17af8ac90>): A function which is given the DataFrame row and should return a Panel object to render as additional detail below the row.
selectable = param.ClassSelector(allow_refs=True, class_=(<class ‘bool’>, <class ‘str’>, <class ‘int’>), default=True, label=’Selectable’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17bd6aad0>): Defines the selection mode of the Tabulator. - True Selects rows on click. To select multiple use Ctrl-select, to select a range use Shift-select - False Disables selection - ‘checkbox’ Adds a column of checkboxes to toggle selections - ‘checkbox-single’ Same as ‘checkbox’ but header does not allow select/deselect all - ‘toggle’ Selection toggles when clicked - int The maximum number of selectable rows.
selectable_rows = param.Callable(allow_None=True, allow_refs=True, label=’Selectable rows’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17bd3ef10>): A function which given a DataFrame should return a list of rows by integer index, which are selectable.
sortable = param.ClassSelector(allow_refs=True, class_=(<class ‘bool’>, <class ‘dict’>), default=True, label=’Sortable’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17bd6b610>): Whether the columns in the table should be sortable. Can either be specified as a simple boolean toggling the behavior on and off or as a dictionary specifying the option per column.
theme = param.ObjectSelector(allow_refs=True, default=’simple’, label=’Theme’, names={}, nested_refs=False, objects=[‘default’, ‘site’, ‘simple’, ‘midnight’, ‘modern’, ‘bootstrap’, ‘bootstrap4’, ‘materialize’, ‘bulma’, ‘semantic-ui’, ‘fast’, ‘bootstrap5’], rx=<param.reactive.reactive_ops object at 0x17bd6b510>): Tabulator CSS theme to apply to table.
theme_classes = param.List(allow_refs=True, bounds=(0, None), class_=<class ‘str’>, default=[], item_type=<class ‘str’>, label=’Theme classes’, nested_refs=True, rx=<param.reactive.reactive_ops object at 0x17bd6bf90>): List of extra CSS classes to apply to the Tabulator element to customize the theme.
title_formatters = param.Dict(allow_refs=True, class_=<class ‘dict’>, default={}, label=’Title formatters’, nested_refs=True, rx=<param.reactive.reactive_ops object at 0x17b7c1710>): Tabulator formatter specification to use for a particular column header title.

add_filter(filter, column=None)[source]#

Adds a filter to the table which can be a static value or dynamic parameter based object which will automatically update the table when changed..

When a static value, widget or parameter is supplied the filtering will follow a few well defined behaviors:

Arguments#

filter: Widget, param.Parameter or FunctionType: The value by which to filter the DataFrame along the declared column, or a function accepting the DataFrame to be filtered and returning a filtered copy of the DataFrame.
column: str or None: Column to which the filter will be applied, if the filter is a constant value, widget or parameter.

Raises#

ValueError: If the filter type is not supported or no column: was declared.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

property current_view: pd.DataFrame#: Returns the current view of the table after filtering and sorting are applied.

download(filename: str = 'table.csv')[source]#

Triggers downloading of the table as a CSV or JSON.

Arguments#

filename: str: The filename to save the table as.

download_menu(text_kwargs={}, button_kwargs={})[source]#

Returns a menu containing a TextInput and Button widget to set the filename and trigger a client-side download of the data.

Arguments#

text_kwargs: dict: Keyword arguments passed to the TextInput constructor
button_kwargs: dict: Keyword arguments passed to the Button constructor

Returns#

filename: TextInput: The TextInput widget setting a filename.
button: Button: The Button that triggers a download.

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

on_click(callback: Callable[[CellClickEvent], None], column: str | None = None)[source]#

Register a callback to be executed when any cell is clicked. The callback is given a CellClickEvent declaring the column and row of the cell that was clicked.

Arguments#

callback: (callable): The callback to run on edit events.
column: (str): Optional argument restricting the callback to a specific column.

on_edit(callback: Callable[[TableEditEvent], None])[source]#

Register a callback to be executed when a cell is edited. Whenever a cell is edited on_edit callbacks are called with a TableEditEvent as the first argument containing the column, row and value of the edited cell.

Arguments#

callback: (callable): The callback to run on edit events.

patch(patch_value, as_index=True)[source]#

Efficiently patches (updates) the existing value with the patch_value.

Arguments#

patch_value: (pd.DataFrame | pd.Series | Dict): The value(s) to patch the existing value with.
as_index: boolean: Whether to treat the patch index as DataFrame indexes (True) or as simple integer index.

Raises#

ValueError: Raised if the patch_value is not a supported type.

Examples#

Patch a DataFrame with a Dictionary row. >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> tabulator = Tabulator(value=value) >>> patch_value = {“x”: [(0, 3)]} >>> tabulator.patch(patch_value) >>> tabulator.value.to_dict(“list”) {‘x’: [3, 2], ‘y’: [‘a’, ‘b’]}

Patch a Dataframe with a Dictionary of Columns. >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> tabulator = Tabulator(value=value) >>> patch_value = {“x”: [(slice(2), (3,4))], “y”: [(1,’d’)]} >>> tabulator.patch(patch_value) >>> tabulator.value.to_dict(“list”) {‘x’: [3, 4], ‘y’: [‘a’, ‘d’]}

Patch a DataFrame with a Series. Please note the index is used in the update. >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> tabulator = Tabulator(value=value) >>> patch_value = pd.Series({“index”: 1, “x”: 4, “y”: “d”}) >>> tabulator.patch(patch_value) >>> tabulator.value.to_dict(“list”) {‘x’: [1, 4], ‘y’: [‘a’, ‘d’]}

Patch a Dataframe with a Dataframe. Please note the index is used in the update. >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> tabulator = Tabulator(value=value) >>> patch_value = pd.DataFrame({“x”: [3, 4], “y”: [“c”, “d”]}) >>> tabulator.patch(patch_value) >>> tabulator.value.to_dict(“list”) {‘x’: [3, 4], ‘y’: [‘c’, ‘d’]}

remove_filter(filter)[source]#: Removes a filter which was previously added.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

property selected_dataframe#: Returns a DataFrame of the currently selected rows.

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

stream(stream_value, rollover=None, reset_index=True, follow=True)[source]#

Streams (appends) the stream_value provided to the existing value in an efficient manner.

Arguments#

stream_value: (pd.DataFrame | pd.Series | Dict): The new value(s) to append to the existing value.
rollover: int: A maximum column size, above which data from the start of the column begins to be discarded. If None, then columns will continue to grow unbounded.
reset_index: (bool, default=True): If True and the stream_value is a DataFrame, then its index is reset. Helps to keep the index unique and named index

Raises#

ValueError: Raised if the stream_value is not a supported type.

Examples#

Stream a Series to a DataFrame >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> tabulator = Tabulator(value=value) >>> stream_value = pd.Series({“x”: 4, “y”: “d”}) >>> tabulator.stream(stream_value) >>> tabulator.value.to_dict(“list”) {‘x’: [1, 2, 4], ‘y’: [‘a’, ‘b’, ‘d’]}

Stream a Dataframe to a Dataframe >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> tabulator = Tabulator(value=value) >>> stream_value = pd.DataFrame({“x”: [3, 4], “y”: [“c”, “d”]}) >>> tabulator.stream(stream_value) >>> tabulator.value.to_dict(“list”) {‘x’: [1, 2, 3, 4], ‘y’: [‘a’, ‘b’, ‘c’, ‘d’]}

Stream a Dictionary row to a DataFrame >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> tabulator = Tabulator(value=value) >>> stream_value = {“x”: 4, “y”: “d”} >>> tabulator.stream(stream_value) >>> tabulator.value.to_dict(“list”) {‘x’: [1, 2, 4], ‘y’: [‘a’, ‘b’, ‘d’]}

Stream a Dictionary of Columns to a Dataframe >>> value = pd.DataFrame({“x”: [1, 2], “y”: [“a”, “b”]}) >>> tabulator = Tabulator(value=value) >>> stream_value = {“x”: [3, 4], “y”: [“c”, “d”]} >>> tabulator.stream(stream_value) >>> tabulator.value.to_dict(“list”) {‘x’: [1, 2, 3, 4], ‘y’: [‘a’, ‘b’, ‘c’, ‘d’]}

`terminal` Module#

The Terminal Widget makes it easy to create Panel Applications with Terminals.

For example apps which streams the output of processes or logs.
For example apps which provide interactive bash, python or ipython terminals

class panel.widgets.terminal.Terminal(output=None, **params)[source]#

Bases: Widget

The Terminal widget renders a live terminal in the browser using the xterm.js library making it possible to display logs or even provide an interactive terminal in a Panel application.

Reference: https://panel.holoviz.org/reference/widgets/Terminal.html

Example:

>>> Terminal(
...     "Welcome to the Panel Terminal!", options={"cursorBlink": True}
... )

Parameters inherited from:

value = param.String(allow_refs=False, constant=True, default=’’, nested_refs=False, readonly=True, rx=<param.reactive.reactive_ops object at 0x17c325b90>): User input received from the Terminal. Sent one character at the time.
clear = param.Action(allow_None=True, allow_refs=False, constant=True, label=’Clear’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17c326e90>): Clears the Terminal.
options = param.Dict(allow_refs=False, class_=<class ‘dict’>, default={}, label=’Options’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17c0fb850>): Initial Options for the Terminal Constructor. cf. https://xtermjs.org/docs/api/terminal/interfaces/iterminaloptions/
output = param.String(allow_refs=False, default=’’, label=’Output’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17c326f10>): System output written to the Terminal
ncols = param.Integer(allow_refs=False, constant=True, default=0, inclusive_bounds=(True, True), label=’Ncols’, nested_refs=False, readonly=True, rx=<param.reactive.reactive_ops object at 0x17c327490>): The number of columns in the terminal.
nrows = param.Integer(allow_refs=False, constant=True, default=0, inclusive_bounds=(True, True), label=’Nrows’, nested_refs=False, readonly=True, rx=<param.reactive.reactive_ops object at 0x17c1b2650>): The number of rows in the terminal.
write_to_console = param.Boolean(allow_refs=False, default=False, label=’Write to console’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17c325210>): Whether or not to write to the server console.
_clears = param.Integer(allow_refs=False, default=0, inclusive_bounds=(True, True), label=’ clears’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17c327b10>): Sends a signal to clear the terminal

_output = param.String(allow_refs=False, default=’’, label=’ output’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17c325090>)

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

property subprocess#: The subprocess enables running commands like ‘ls’, [‘ls’, ‘-l’], ‘bash’, ‘python’ and ‘ipython’ in the terminal.

class panel.widgets.terminal.TerminalSubprocess(terminal, **kwargs)[source]#

Bases: Parameterized

The TerminalSubProcess is a utility class that makes running subprocesses via the Terminal easy.

args = param.ClassSelector(allow_None=True, allow_refs=False, class_=(<class ‘str’>, <class ‘list’>), label=’Args’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17c374150>): The arguments used to run the subprocess. This may be a string or a list. The string cannot contain spaces. See subprocess.run docs for more details.
kill = param.Action(allow_None=True, allow_refs=False, constant=True, label=’Kill’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17c375890>): Kills the running process
kwargs = param.Dict(allow_None=True, allow_refs=False, class_=<class ‘dict’>, label=’Kwargs’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17c374090>): Any other arguments to run the subprocess. See subprocess.run docs for more details.
running = param.Boolean(allow_refs=False, constant=True, default=False, label=’Running’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17c3757d0>): Whether or not the subprocess is running.
_child_pid = param.Integer(allow_refs=False, default=0, inclusive_bounds=(True, True), label=’ child pid’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17c375bd0>): Child process id
_fd = param.Integer(allow_refs=False, default=0, inclusive_bounds=(True, True), label=’ fd’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17c376290>): Child file descriptor.

_max_read_bytes = param.Integer(allow_refs=False, default=20480, inclusive_bounds=(True, True), label=’ max read bytes’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17c375c10>)

_periodic_callback = param.ClassSelector(allow_None=True, allow_refs=False, class_=<class ‘panel.io.callbacks.PeriodicCallback’>, label=’ periodic callback’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17c375910>): Watches the subprocess for output
_period = param.Integer(allow_refs=False, default=50, inclusive_bounds=(True, True), label=’ period’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17c375c10>): Period length of _periodic_callback
_terminal = param.Parameter(allow_None=True, allow_refs=False, constant=True, label=’ terminal’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17c375550>): The Terminal to which the subprocess is connected.

_timeout_sec = param.Integer(allow_refs=False, default=0, inclusive_bounds=(True, True), label=’ timeout sec’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17c375f90>)

_watcher = param.Parameter(allow_None=True, allow_refs=False, label=’ watcher’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17c375550>): Watches the subprocess for user input

run(*args, **kwargs)[source]#: Runs a subprocess command.

`text_to_speech` Module#

The Panel TextToSpeak Widget provides functionality for text to speech via the the HTML5 SpeechSynthesis API.

See https://developer.mozilla.org/en-US/docs/Web/API/SpeechSynthesis

The term utterance is used throughout the API. It is the smallest unit of speech in spoken language analysis.

class panel.widgets.text_to_speech.TextToSpeech(*, _voices, auto_speak, cancel, pause, resume, speak, lang, pitch, rate, voice, volume, disabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, value, name)[source]#

Bases: Utterance, Widget

The TextToSpeech widget wraps the HTML5 SpeechSynthesis API

See https://developer.mozilla.org/en-US/docs/Web/API/SpeechSynthesis

Reference: https://panel.holoviz.org/reference/widgets/TextToSpeech.html

Example:

>>> TextToSpeech(name="Speech Synthesis", value="Data apps are nice")

Parameters inherited from:

auto_speak = param.Boolean(allow_refs=False, default=True, label=’Auto speak’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17c545dd0>): Whether or not to automatically speak when the value changes.
cancel = param.Event(allow_refs=False, default=False, label=’Cancel’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17c4435d0>): Removes all utterances from the utterance queue.
pause = param.Event(allow_refs=False, default=False, label=’Pause’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17c545ed0>): Puts the TextToSpeak object into a paused state.
resume = param.Event(allow_refs=False, default=False, label=’Resume’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17c5466d0>): Puts the TextToSpeak object into a non-paused state: resumes it if it was already paused.
paused = param.Boolean(allow_refs=False, constant=True, default=False, label=’Paused’, nested_refs=False, readonly=True, rx=<param.reactive.reactive_ops object at 0x17c545e90>): A Boolean that returns true if the TextToSpeak object is in a paused state.
pending = param.Boolean(allow_refs=False, constant=True, default=False, label=’Pending’, nested_refs=False, readonly=True, rx=<param.reactive.reactive_ops object at 0x17c546610>): A Boolean that returns true if the utterance queue contains as-yet-unspoken utterances.
speak = param.Event(allow_refs=False, default=False, label=’Speak’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17c545e90>): Speak. I.e. send a new Utterance to the browser
speaking = param.Boolean(allow_refs=False, constant=True, default=False, label=’Speaking’, nested_refs=False, readonly=True, rx=<param.reactive.reactive_ops object at 0x17c5469d0>): A Boolean that returns true if an utterance is currently in the process of being spoken — even if TextToSpeak is in a paused state.
voices = param.List(allow_refs=False, bounds=(0, None), constant=True, default=[], label=’Voices’, nested_refs=False, readonly=True, rx=<param.reactive.reactive_ops object at 0x17c545e90>): Returns a list of Voice objects representing all the available voices on the current device.

_voices = param.List(allow_refs=False, bounds=(0, None), default=[], label=’ voices’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17c5466d0>)

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

set_voices(voices)[source]#: Updates the lang and voice parameter objects, default and value

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

to_dict(include_uuid=True)[source]#

Returns the object parameter values in a dictionary

Returns:: Dict: [description]

class panel.widgets.text_to_speech.Utterance(*, lang, pitch, rate, value, voice, volume, name)[source]#

Bases: Parameterized

An utterance is the smallest unit of speech in spoken language analysis.

The Utterance Model wraps the HTML5 SpeechSynthesisUtterance API

See https://developer.mozilla.org/en-US/docs/Web/API/SpeechSynthesisUtterance

value = param.String(allow_refs=False, default=’’, label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17c45d090>): The text that will be synthesised when the utterance is spoken. The text may be provided as plain text, or a well-formed SSML document.
lang = param.ObjectSelector(allow_refs=False, default=’’, label=’Lang’, names={}, nested_refs=False, objects=[‘’], rx=<param.reactive.reactive_ops object at 0x17c5509d0>): The language of the utterance.
pitch = param.Number(allow_refs=False, bounds=(0.0, 2.0), default=1.0, inclusive_bounds=(True, True), label=’Pitch’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17c550610>): The pitch at which the utterance will be spoken at expressed as a number between 0 and 2.
rate = param.Number(allow_refs=False, bounds=(0.1, 10.0), default=1.0, inclusive_bounds=(True, True), label=’Rate’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17c550190>): The speed at which the utterance will be spoken at expressed as a number between 0.1 and 10.
voice = param.ObjectSelector(allow_refs=False, label=’Voice’, names={}, nested_refs=False, objects=[], rx=<param.reactive.reactive_ops object at 0x17c4c9f90>): The voice that will be used to speak the utterance.
volume = param.Number(allow_refs=False, bounds=(0.0, 1.0), default=1.0, inclusive_bounds=(True, True), label=’Volume’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17c5189d0>): The volume that the utterance will be spoken at expressed as a number between 0 and 1.

set_voices(voices)[source]#: Updates the lang and voice parameter objects, default and value

to_dict(include_uuid=True)[source]#

Returns the object parameter values in a dictionary

Returns:: Dict: [description]

class panel.widgets.text_to_speech.Voice(*, default, lang, local_service, voice_uri, name)[source]#

Bases: Parameterized

The current device (i.e. OS and Browser) provides a list of Voices. Each with a unique name and speaking a specific language.

Wraps the HTML5 SpeecSynthesisVoice API

See https://developer.mozilla.org/en-US/docs/Web/API/SpeechSynthesisVoice

default = param.Boolean(allow_refs=False, constant=True, default=False, label=’Default’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17c5532d0>): A Boolean indicating whether the voice is the default voice for the current app language (True), or not (False.)
lang = param.String(allow_refs=False, constant=True, default=’’, label=’Lang’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17c553c90>): Returns a BCP 47 language tag indicating the language of the voice.
local_service = param.Boolean(allow_refs=False, constant=True, default=False, label=’Local service’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17c5533d0>): A Boolean indicating whether the voice is supplied by a local speech synthesizer service (True), or a remote speech synthesizer service (False.)
voice_uri = param.String(allow_refs=False, constant=True, default=’’, label=’Voice uri’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17c553b90>): Returns the type of URI and location of the speech synthesis service for this voice.

static group_by_lang(voices)[source]#: Returns a dictionary where the key is the lang and the value is a list of voices for that language.

static to_voices_list(voices)[source]#: Returns a list of Voice objects from the list of dicts provided

`texteditor` Module#

Defines a WYSIWYG TextEditor widget based on quill.js.

class panel.widgets.texteditor.TextEditor(**params: Any)[source]#

Bases: Widget

The TextEditor widget provides a WYSIWYG (what-you-see-is-what-you-get) rich text editor which outputs HTML.

The editor is built on top of the [Quill.js](https://quilljs.com/) library.

Reference: https://panel.holoviz.org/reference/widgets/TextEditor.html

Example:

>>> TextEditor(placeholder='Enter some text')

Parameters inherited from:

value = param.String(allow_refs=False, default=’’, label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17c6ff310>): State of the current text in the editor
disabled = param.Boolean(allow_refs=False, default=False, label=’Disabled’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17c704990>): Whether the editor is disabled.
mode = param.Selector(allow_refs=False, default=’toolbar’, label=’Mode’, names={}, nested_refs=False, objects=[‘bubble’, ‘toolbar’], rx=<param.reactive.reactive_ops object at 0x17c6fe650>): Whether to display a toolbar or a bubble menu on highlight.
toolbar = param.ClassSelector(allow_refs=False, class_=(<class ‘list’>, <class ‘bool’>), default=True, label=’Toolbar’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17c705090>): Toolbar configuration either as a boolean toggle or a configuration specified as a list.
placeholder = param.String(allow_refs=False, default=’’, label=’Placeholder’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17c6fe090>): Placeholder output when the editor is empty.

clone(**params) → Viewable[source]#: Makes a copy of the object sharing the same parameters.

Arguments#

params: Keyword arguments override the parameters on the clone.

Returns#

Cloned Viewable object

controls(parameters: list[str] = [], jslink: bool = True, **kwargs) → BasePanel[source]#

Creates a set of widgets which allow manipulating the parameters on this instance. By default all parameters which support linking are exposed, but an explicit list of parameters can be provided.

Arguments#

parameters: list(str): An explicit list of parameters to return controls for.
jslink: bool: Whether to use jslinks instead of Python based links. This does not allow using all types of parameters.
kwargs: dict: Additional kwargs to pass to the Param pane(s) used to generate the controls widgets.

Returns#

A layout of the controls

embed(max_states: int = 1000, max_opts: int = 3, json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = False, states={}) → None[source]#

Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model. Note this will only work well for simple apps with a relatively small state space.

Arguments#

max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for JSON filename
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=False): Whether to report progress
states: dict (default={}): A dictionary specifying the widget values to embed for each widget

classmethod from_param(parameter: param.Parameter, **params) → T[source]#

Construct a widget from a Parameter and link the two bi-directionally.

Parameters#

parameter: param.Parameter: A parameter to create the widget from.

Returns#

Widget instance linked to the supplied parameter

get_root(doc: Document | None = None, comm: Comm | None = None, preprocess: bool = True) → Model[source]#

Returns the root model and applies pre-processing hooks

Arguments#

doc: bokeh.Document: Bokeh document the bokeh model will be attached to.
comm: pyviz_comms.Comm: Optional pyviz_comms when working in notebook
preprocess: boolean (default=True): Whether to run preprocessing hooks

Returns#

Returns the bokeh model corresponding to this panel object

jscallback(args: dict[str, Any] = {}, **callbacks: str) → Callback[source]#

Allows defining a JS callback to be triggered when a property changes on the source object. The keyword arguments define the properties that trigger a callback and the JS code that gets executed.

Arguments#

args: dict: A mapping of objects to make available to the JS callback
callbacks: dict: A mapping between properties on the source model and the code to execute when that property changes

Returns#

callback: Callback: The Callback which can be used to disable the callback.

jslink(target: JSLinkTarget, code: dict[str, str] = None, args: dict | None = None, bidirectional: bool = False, **links: str) → Link[source]#

Links properties on the this Reactive object to those on the target Reactive object in JS code.

Supports two modes, either specify a mapping between the source and target model properties as keywords or provide a dictionary of JS code snippets which maps from the source parameter to a JS code snippet which is executed when the property changes.

Arguments#

target: panel.viewable.Viewable | bokeh.model.Model | holoviews.core.dimension.Dimensioned: The target to link the value to.
code: dict: Custom code which will be executed when the widget value changes.
args: dict: A mapping of objects to make available to the JS callback
bidirectional: boolean: Whether to link source and target bi-directionally
links: dict: A mapping between properties on the source model and the target model property to link it to.

Returns#

link: GenericLink: The GenericLink which can be used unlink the widget and the target model.

link(target: Parameterized, callbacks: dict[str, str | Callable] | None = None, bidirectional: bool = False, **links: str) → Watcher[source]#

Links the parameters on this Reactive object to attributes on the target Parameterized object.

Supports two modes, either specify a mapping between the source and target object parameters as keywords or provide a dictionary of callbacks which maps from the source parameter to a callback which is triggered when the parameter changes.

Arguments#

target: param.Parameterized: The target object of the link.
callbacks: dict | None: Maps from a parameter in the source object to a callback.
bidirectional: bool: Whether to link source and target bi-directionally
links: dict: Maps between parameters on this object to the parameters on the supplied object.

save(filename: str | PathLike | IO, title: str | None = None, resources: Resources | None = None, template: str | Template | None = None, template_variables: dict[str, Any] = {}, embed: bool = False, max_states: int = 1000, max_opts: int = 3, embed_json: bool = False, json_prefix: str = '', save_path: str = './', load_path: str | None = None, progress: bool = True, embed_states: dict[Any, Any] = {}, as_png: bool | None = None, **kwargs) → None[source]#

Saves Panel objects to file.

Arguments#

filename: str or file-like object: Filename to save the plot to
title: string: Optional title for the plot
resources: bokeh resources: One of the valid bokeh.resources (e.g. CDN or INLINE)
template:: passed to underlying io.save
template_variables:: passed to underlying io.save
embed: bool: Whether the state space should be embedded in the saved file.
max_states: int: The maximum number of states to embed
max_opts: int: The maximum number of states for a single widget
embed_json: boolean (default=True): Whether to export the data to json files
json_prefix: str (default=’’): Prefix for the auto-generated json directory
save_path: str (default=’./’): The path to save json files to
load_path: str (default=None): The path or URL the json files will be loaded from.
progress: boolean (default=True): Whether to report progress
embed_states: dict (default={}): A dictionary specifying the widget values to embed for each widget
as_png: boolean (default=None): To save as a .png. If None save_png will be true if filename is string and ends with png.

select(selector: type | Callable[[Viewable], bool] | None = None) → list[Viewable][source]#

Iterates over the Viewable and any potential children in the applying the Selector.

Arguments#

selector: type or callable or None: The selector allows selecting a subset of Viewables by declaring a type or callable function to filter by.

Returns#

viewables: list(Viewable)

servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) → ServableMixin[source]#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Arguments#

titlestr: A string title to give the Document (if served as an app)
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.
area: str (deprecated): The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target: str: Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Returns#

The Panel object itself

server_doc(doc: Document | None = None, title: str | None = None, location: bool | 'Location' = True) → Document[source]#

Returns a serveable bokeh Document with the panel attached

Arguments#

docbokeh.Document (optional): The bokeh Document to attach the panel to as a root, defaults to bokeh.io.curdoc()
titlestr: A string title to give the Document
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

docbokeh.Document: The bokeh document the panel was attached to

show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) → StoppableThread' | 'Server[source]#

Starts a Bokeh server and displays the Viewable in a new tab.

Arguments#

titlestr | None: A string title to give the Document (if served as an app)
port: int (optional, default=0): Allows specifying a specific port
addressstr: The address the server should listen on for HTTP requests.
websocket_origin: str or list(str) (optional): A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded: boolean (optional, default=False): Whether to launch the Server on a separate thread, allowing interactive use.
verbose: boolean (optional, default=True): Whether to print the address and port
openboolean (optional, default=True): Whether to open the server in a new browser tab
locationboolean or panel.io.location.Location: Whether to create a Location component to observe and set the URL location.

Returns#

server: bokeh.server.Server or panel.io.server.StoppableThread: Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

`widget` Module#

class panel.widgets.widget.fixed(value: Any, **kwargs: Any)[source]#

Bases: Parameterized

A pseudo-widget whose value is fixed and never synced to the client.

description = param.String(allow_refs=False, default=’’, label=’Description’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17c9127d0>)

value = param.Parameter(allow_None=True, allow_refs=False, label=’Value’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x17c943010>): Any Python object

get_interact_value()[source]#: Return the value for this widget which should be passed to interactive functions. Custom widgets can change this method to process the raw value self.value.

class panel.widgets.widget.widget(*, name)[source]#

Bases: ParameterizedFunction

Attempts to find a widget appropriate for a given value.

Arguments#

name: str: The name of the resulting widget.
value: Any: The value to deduce a widget from.
default: Any: The default value for the resulting widget.
**params: Any: Additional keyword arguments to pass to the widget.

Returns#

Widget

classmethod instance(**params)[source]#: Return an instance of this class, copying parameters from any existing instance provided.

static widget_from_iterable(o, name)[source]#: Make widgets from an iterable. This should not be done for a string or tuple.

static widget_from_single_value(o, name)[source]#: Make widgets from single values, which can be used as parameter defaults.

static widget_from_tuple(o, name, default)[source]#: Make widgets from a tuple abbreviation.